[NETBEANS-6425] Provide outline view for Groovy file in VSCode. #3525

ppisl · 2022-01-28T11:55:52Z

This is the outlineview implementation not only for Groovy files, but for all GSF languages that are/will be enabled in the Vs Code extension. At the moment it is for Groovy files and YAML files that have application or bootstrap prefix.

The implementation requires adding two interfaces to the LSP API. Clients can implement and register a StructureProvider into MimeLookup for a given mimetype. StructureProvider provides a list of top symbols to be displayed in the outline view. The symbol structure is composed of StrctureElements.

StructureElements are then translated into DocumentSymbols on the VSCode API side, which are displayed in the outline view and also in Go to a symbol (CTRL+SHIFT+O by default). DocumentSymbol has two methods getName() and getDetail(), which both return String and the resulting compound text is displayed in the outline view, where the text returned by getName() is slightly larger than the text returned by getDetail(). On the other hand, only the text returned by getName() is displayed in Go to a symbol. The DocumentSymbol documentation says that getName() should return the name of the symbol and getDetail() should return the detail of the symbol, such as the signature of the function.

Currently in outline view we display the signature as the symbol name and the type as the symbol detail for java files. This means that in Go to a symbol we display not only the names but the symbol, but also signatures with the types of the function parameters, which can affect the symbol search. You can see on this picture, what I mean: https://issues.apache.org/jira/secure/attachment/13039469/Screenshot%20from%202022-01-28%2011-05-32.png

On the other hand, the java extension offered by Microsoft does the same. However, in my opinion, getName should really return only the name of the symbols and this would make the search in Go to symbol easier.

This PR also moves the existing functionality that provided outline view for java files outside the LSP server. The JavaStructureProvider implementation is now in the java.editor module, which already has a dependency on the LSP API. Provider should logically belong to java.navigation module, but this module is not enabled for VsCode extension and if we enable it, it brings with it dependency on WindowsSystem.API, which is not sufficient now.

Initial commit

ppisl · 2022-01-28T11:56:56Z

There are no tests yet, I need to write them.

JaroslavTulach

Great refactoring, just get ready for evolution of StructureElement. And write at least one test!

ide/api.lsp/src/org/netbeans/api/lsp/StructureElement.java

...va.lsp.server/src/org/netbeans/modules/java/lsp/server/protocol/TextDocumentServiceImpl.java

ide/api.lsp/src/org/netbeans/api/lsp/StructureElement.java

ide/api.lsp/src/org/netbeans/spi/lsp/StructureProvider.java

ppisl · 2022-02-08T14:43:23Z

There are no tests yet, I need to write them.

There is now test for the api.

ide/api.lsp/src/org/netbeans/spi/lsp/StructureProvider.java

sdedic · 2022-01-28T12:29:49Z

ide/csl.api/src/org/netbeans/modules/csl/navigation/GsfStructureProvider.java

+                case KEYWORD: return Kind.Key;
+                case OTHER: return Kind.Object;
+                case PACKAGE: return Kind.Package;
+                case PARAMETER: return Kind.TypeParameter;


What is PARAMETER really in csl langugaes used for ?

It depends on the language.

sdedic · 2022-02-11T14:02:29Z

ide/csl.api/src/org/netbeans/modules/csl/navigation/GsfStructureProvider.java

+                createTags(item, builder);
+
+                try {
+                    String prefix = doc.getText(lineStart, startOffset);


lineStart was assigned the value of startOffset (line 210), but was never changed after that -- maybe swap lines 219 & 220 ?

The code i a little bit misleading. I have change it little bit. I will try to explain the logic:

class A { | def methodC {} { } }

The | marks text cursor, in this case the logic counts the expanded offset from the beginning of the line, becase on the line starts methodC definition. So in this case the methodC element is selected. But when you have something like:

class A{ int field1; |int field2 }

the start of the expanded offset will be the same as selected offset of the element field2 and not from the begining of the line.

This is useful for example for yaml files like:

martin: name: Martin D'vloper | job: Developer skill: Elite

The ui will select the job item, not martin structure (that will be selected if the job expanded offsets will be the same lake selected offsets.

sdedic · 2022-02-11T14:37:59Z

ide/csl.api/src/org/netbeans/modules/csl/navigation/GsfStructureProvider.java

+                    } else if (lastElement.getExpandedStartOffset() <= lineStart && lineEnd == lastElement.getExpandedEndOffset()) {
+                        // The same line
+                        sElements.remove(lastElement);
+                        Builder leBuilder = StructureProvider.newBuilder(lastElement.getName(), lastElement.getKind());


What about adding Builder StructureProvider.copy(StructureElement from) ? All the settings can be copied, the caller will just call builder methods for changes.

I was thinking about this as well. I will do it.

Will be in the next commit.

sdedic · 2022-02-11T14:42:32Z

...va.lsp.server/src/org/netbeans/modules/java/lsp/server/protocol/TextDocumentServiceImpl.java

-                        if (ds != null)
+            StructureProvider structureProvider = MimeLookup.getLookup(DocumentUtilities.getMimeType(doc)).lookup(StructureProvider.class);
+            if (structureProvider != null) {
+                return structureProvider.getStructure(doc).thenApply(structureElements -> {


The implementations (java, GSF) in this PR will actually block, not fork; so this will likely block the LSP message thread until the parsing is done. I was about to suggest in the GSF impl that it should fork the .parse() into a RP, but maybe it would be better to do the fork here, centrally (?)

I have put it into the Background taks.

sdedic · 2022-02-11T14:59:12Z

java/java.editor/src/org/netbeans/modules/editor/java/JavaStructureProvider.java

+                builder.children(jse);
+            }
+        }
+        if (path.getLeaf().getKind() == Tree.Kind.METHOD || path.getLeaf().getKind() == Tree.Kind.VARIABLE) {


What about initializers ?

I have copied the original code here. I didn't changed the logic.

sdedic · 2022-02-11T15:14:08Z

ide/api.lsp/src/org/netbeans/api/lsp/StructureElement.java

+
+    private final String name;
+    private final String detail;
+    private final int selectionStartOffset;


A weird idea: if javax.swing.text.Position is used here, the structure could survive some edits between the time StructureElement is created and transofmed into LSP4J wire format -- and during the translation the document could be readlocked to protect the consistency. @JaroslavTulach ?

Do we want the structure to represent read-only snapshot and be always re-created from scratch? Or do we want the structure to be updated?

I believe we strive for the first approach. As such making the fields final more properly represents the snapshot nature of the structure. Implementations can of course maintain javax.swing.text.Position internally.

[NETBEANS-6425] Code completion for class fields doesn't work.

36d2d1b

Initial commit

sdedic requested review from JaroslavTulach, dbalek and sdedic January 28, 2022 12:23

mbien added Groovy VSCode Extension [ci] enable VSCode Extension tests labels Jan 28, 2022

JaroslavTulach reviewed Jan 28, 2022

View reviewed changes

Improving StructureProvider, StructureElement, adding builder and tests.

02ae425

JaroslavTulach approved these changes Feb 9, 2022

View reviewed changes

ide/api.lsp/src/org/netbeans/spi/lsp/StructureProvider.java Outdated Show resolved Hide resolved

ide/api.lsp/src/org/netbeans/spi/lsp/StructureProvider.java Outdated Show resolved Hide resolved

ppisl added 2 commits February 11, 2022 10:13

Better handling adding sub nodes.

d0971f6

Reflecting changes from StructureProvider.Builder in tests

077cb09

sdedic reviewed Feb 11, 2022

View reviewed changes

ppisl added 2 commits February 14, 2022 18:35

Polishing StructureProvide and StructureElement

fe1b2ec

Making ServerTest running

60e2a7b

sdedic merged commit 7bccd05 into apache:master Feb 21, 2022

ppisl deleted the NETBEANS-6425 branch April 13, 2022 09:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[NETBEANS-6425] Provide outline view for Groovy file in VSCode. #3525

[NETBEANS-6425] Provide outline view for Groovy file in VSCode. #3525

ppisl commented Jan 28, 2022 •

edited

ppisl commented Jan 28, 2022

JaroslavTulach left a comment

ppisl commented Feb 8, 2022

sdedic Jan 28, 2022

ppisl Feb 14, 2022

sdedic Feb 11, 2022

ppisl Feb 14, 2022

ppisl Feb 14, 2022 •

edited

sdedic Feb 11, 2022

ppisl Feb 14, 2022

ppisl Feb 14, 2022

sdedic Feb 11, 2022

ppisl Feb 14, 2022

sdedic Feb 11, 2022

ppisl Feb 14, 2022

sdedic Feb 11, 2022

JaroslavTulach Feb 12, 2022 •

edited

[NETBEANS-6425] Provide outline view for Groovy file in VSCode. #3525

[NETBEANS-6425] Provide outline view for Groovy file in VSCode. #3525

Conversation

ppisl commented Jan 28, 2022 • edited

ppisl commented Jan 28, 2022

JaroslavTulach left a comment

Choose a reason for hiding this comment

ppisl commented Feb 8, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ppisl Feb 14, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JaroslavTulach Feb 12, 2022 • edited

Choose a reason for hiding this comment

ppisl commented Jan 28, 2022 •

edited

ppisl Feb 14, 2022 •

edited

JaroslavTulach Feb 12, 2022 •

edited