Show package declaration for the binary types in outline

[sandipchitale]

The Outline view for java.io.PrintStream does show package node.

Environment

• Operating System: All
• JDK version: JDK17
• Visual Studio Code version:

Version: 1.77.3 (system setup)
Commit: 704ed70d4fd1c6bd6342c436f1ede30d1cff4710
Date: 2023-04-12T09:16:02.548Z
Electron: 19.1.11
Chromium: 102.0.5005.196
Node.js: 16.14.2
V8: 10.2.154.26-electron.0
OS: Windows_NT x64 10.0.22621
Sandboxed: No

• Java extension version: 1.18.2023041704

Steps To Reproduce

1. Show java.io.PrintStream class
2. Open Outline view

Current Result

The package node java.io is not shown.

Expected Result

The package node java.io should be shown.

[jdneo]

This looks like something by design.

The same behavior can be observed in Eclipse as well.

Actually all the IClassFile instance won't have the package declaration information from API level - when we call getChildren().

[sandipchitale]

I see. But showing it will be useful. Also it is useful to generate FQNs for setting method (function) breakpoints etc. For example: #1298

[jdneo]

Marked as a feature request.

[sandipchitale]

BTW FWIW I was able to figure out the package name by processing the location.uri:

        // Try to figure out package name from location.uri.path '/java.base/java.io/PrintStream.class'
        let packageName: string | undefined;
        if ((documentSymbol as any).location && (documentSymbol as any).location.uri.scheme === 'jdt') {
            const path = (documentSymbol as any).location.uri.path;
            const pathParts = path.split('/');
            if (pathParts.length > 2) {
                packageName = pathParts[2];
            }
        }

[jdneo]

Would you like to contribute a pull request for that?

[sandipchitale]

@jdneo I will give it a try, but not sure what we would like to happen. Basically use the technique above and generate a package node and show it? If so I can give it a try.

[jdneo]

I think the above technique looks promising. And it would be even better if the change can happen at the server side so all clients can get it for free.

The code point is at: https://github.com/eclipse/eclipse.jdt.ls/blob/73ccd84d4a0f57312ece7c049c27c6e685a889fe/org.eclipse.jdt.ls.core/src/org/eclipse/jdt/ls/core/internal/handlers/DocumentSymbolHandler.java#L150

Seems that we need some special logic to handle IClassFile and construct a package symbol according to the uri.

[sandipchitale]

@jdneo Ah, you are suggesting to fix it on eclipse side. I will see if I can create a PR for that, i have done eclipse development in the past.

But it appears that thelocation.uri - jdt:///content/... already has some information about the package name in the uri.path, which the above technic is exploiting. What if we fix this on the client side in the interim by synthetically adding a DocumentSymbol for package using the above technic.

[jdneo]

I just took a look at the server-side implementation, and looks like there is no need to parse the uri string.

Even more simple: you can directly call unit.getParent().getElementName() to get the package name.

[sandipchitale]

@jdneo Are you going to propose the above solution?

[jdneo]

unit.getParent().getElementName() makes more sense because the uri sent to client is built from that:

https://github.com/eclipse/eclipse.jdt.ls/blob/06716e21d336f8acbb5c99d29e19f252cfffe83a/org.eclipse.jdt.ls.core/src/org/eclipse/jdt/ls/core/internal/JDTUtils.java#L825

It would be awesome if you are interested in raising a PR for that. But it's totally fine if you don't have time to do so.

[sandipchitale]

As a first step filed an issue: eclipse-jdtls/eclipse.jdt.ls#2617

I will look into the PR there.

[sandipchitale]

Also see: microsoft/vscode-java-debug#1298

[sandipchitale]

@jdneo @rgrunber Thanks for fixing this. I am able to use it in my VSCode extension VSCode Java Debugger Extras to set method (function) breakpoints in .class files as well (from a custom Outline view). The extension had to implement the custom Outline (Java Debugger) view as the standard Outline view does not allow adding node context actions. See: microsoft/vscode#49925). Hoping to eventually implement Class laoding, CTOR, field access and modification breakpoints once the underlying debugger supports them (See microsoft/vscode-java-debug#1298).