Support viewing inherited members through QuickPick UI. #2590

gayanper · 2022-07-22T13:46:22Z

The reference view API is used to show the document outline with inherited
symbols using the new java.ls extension method.

Signed-off-by: Gayan Perera [email protected]

gayanper · 2022-07-22T14:10:30Z

@rgrunber please have a look at the patch and let me know what you think ?

jdneo · 2022-07-27T07:34:55Z

Is it possible to display them in the outline view?

My thought is: we can register a switch button at the navigation bar of the outline view like this:

"menus": {
            "view/title": [
                {
                    "command": "<Enable Inherited Members Command>",
                    "when": "view == outline",
                    "group": "navigation"
                },
                ...
            ],
}

Then JDT.LS will provide different content based on current mode.

gayanper · 2022-07-27T16:45:51Z

@jdneo You mean using the new ls extension method ?

jdneo · 2022-07-28T01:41:10Z

@gayanper

Not exactly. I'm thinking that we should use the existing LSP request for document symbols. At JDT.LS side, it will store a preference saying that which mode is enabled now (show inherited members or not) and return the response accordingly.

gayanper · 2022-07-28T05:24:32Z

@jdneo ahhh i see, thats sounds neat. I can have a look at it this weekend.

jdneo · 2022-07-28T05:51:55Z

BTW, one thing might be tricky and risk: I'm not sure if it's possible to let outline view do a refresh programmatically. Since when the mode is changed, the content needs to do a refresh.

Seems impossible now: microsoft/vscode#108722

gayanper · 2022-07-31T11:25:15Z

@jdneo the refreshing is a issue. One possibility is try to trigger a file change event, but I couldn’t find a way to that either.

Another issue is when we add the menu item into view/title it is also shown for other languages as well, I couldn’t find away to remove or disable it based on the active editor which is presented by outline.

Even finding a way to disable it, it will be shown for all languages. Therefore it seems to be better that showing inherited members comes from vscode it self so we have more control over the action/menus.

jdneo · 2022-08-01T01:36:19Z

Another issue is when we add the menu item into view/title it is also shown for other languages as well

Will adding editorLangId == typescript to the when clause works in this case?

But the 'refresh' blocks us anyway. What if we do not expose the shortcut at the navigation bar of the outline view? Instead, we just exposing a setting first.

Because when user is changing the setting's value, the user must switch between editors and the change of the editor will kick off a new document symbol request (if I remeber it correctly) and thus refresh the outline view?

gayanper · 2022-08-01T18:03:15Z

Another issue is when we add the menu item into view/title it is also shown for other languages as well

Will adding editorLangId == typescript to the when clause works in this case?

No it doesn't work. Seems like editorLangId is not present I this view context.

But the 'refresh' blocks us anyway. What if we do not expose the shortcut at the navigation bar of the outline view? Instead, we just exposing a setting first.

Because when user is changing the setting's value, the user must switch between editors and the change of the editor will kick off a new document symbol request (if I remeber it correctly) and thus refresh the outline view?

I can try that out and see if it solves.

gayanper · 2022-08-06T18:33:43Z

I tried the approach you mentioned @jdneo. We have few issues

When opening the file the symbols are cached, so basically you need to close and open editor to send another request to LS to consider the preference when loading symbols or the file must change.
The vscode outline UI always use the document uri to open the symbol. This is because it assume what is shown are only part of current document. So even we send SymbolInformation which has the support to send the URI it doesn't work when trying to select a symbol

Therefore I guess for now we can only have our own outline UI with our own LS extension since otherwise the document symbol quick picker will have symbols which cannot be navigated to.

WDYT ?

jdneo · 2022-08-08T01:55:11Z

@gayanper, thank you for trying that approach!

I filed an issue at VS Code repo about the uri support for document symbol: microsoft/vscode#157461

Therefore I guess for now we can only have our own outline UI with our own LS extension since otherwise the document symbol quick picker will have symbols which cannot be navigated to.

Yes, looks like in short term we have to forget about the integrated outline view 😥. The reference view in your initial commit might be an option.

@testforstephen @rgrunber What do you think? Should we go forward to use reference view to show the inherited members, or we wait for VS Code team's opinion a little bit then decide where will we go?

manojbaishya · 2022-08-31T10:54:07Z

I want to give some inputs on how Eclipse shows inherited fields and members:

Eclipse

Outline View

Type Hierarchy (with "Show all inherited members" enabled)

Navigation from Type Hierarchy panel

Visual Studio Code

Outline and References: Class Hierarchy

Navigation from Class Hierarchy

jdneo · 2022-09-07T06:30:19Z

The upstream request is in the stage of collecting upvotes now. For anyone want to have this capability, please vote (👍) at microsoft/vscode#157461.

rgrunber · 2022-09-08T00:02:08Z

The change works pretty well for me. I would be fine with reviewing the 2 contributions (JDT-LS + vscode-java) to at least get this merged until we can use the outline view instead.

We could then also add some of the options available to the outline view. (eg. sort elements, exclude fields, static members, non-public members, etc.)

Overall though, it would be nice to expose the "extended members" from the symbol outline of the command palette This is the closest thing to ctrl+o within Eclipse, and a faster way to navigate.

manojbaishya · 2022-11-20T16:49:37Z

Hello, can we please have this merged? Thanks!

jdneo · 2022-11-22T03:06:21Z

Looks like the API change for outline view won't happen in the near future, we can go with the reference view now. I'll review this PR recently.

package.json

jdneo · 2022-11-22T07:12:47Z

src/outline/model.ts

+		}
+
+		const params: DocumentSymbolParams = {
+			textDocument: TextDocumentIdentifier.create(this.location.uri.toString())


How about we do not persist the document location as a member, but always get the active document's uri (if it's available and is a java-like file).

By doing this, after user changes focus to another java file, he can click the refresh button to get the extended outline for the new file.

If we do so will it be violating the intended API usage ?

Do you mean the API of the reference view?

I think the reference view's API does not ban us to do so?

What we need is just change textDocument: TextDocumentIdentifier.create(this.location.uri.toString()) to textDocument: TextDocumentIdentifier.create(window.activeEditor.document.uri.toString()) with some checks before to make sure the document is available and is a java-like file.

jdneo · 2022-11-22T07:13:46Z

src/standardLanguageClient.ts

@@ -543,6 +544,17 @@ export class StandardLanguageClient {
 				}
 			}));

+			context.subscriptions.push(commands.registerCommand(Commands.SHOW_EXTEND_OUTLINE, (location: any) => {


Besides register a command to let user trigger manually. Is it possible that when we received an active editor change event (window.onDidChangeActiveTextEditor), we help user to auto refresh the extended outline view if it's expanded now. - need to check if the reference view api has such capability to let us check its expand status.

@CsCherrYY Do you know how to get the expand status of the reference view?

I think there is no such API in specific reference view extension. Since reference view is a tree view isself, maybe there is some status we can get from that tree view?

gayanper · 2023-03-26T10:10:15Z

@CsCherrYY @rgrunber @jdneo @testforstephen I would like to reiterate on this. I was looking into vscode quick outline and outline view are more build toward the document outline. Therefore my new suggestion is, we introduce outline hierarchy similar to call hierarchy or type hierarchy as a separate command. We can use the same reference view to start with.

WDYT ?

jdneo · 2023-03-27T01:41:49Z

@gayanper I'm fine with that approach. It looks like the VS Code team will expose the required APIs for the outline view. We can go with the reference view first.

manojbaishya · 2023-05-04T07:09:18Z

May this feature please be merged? :)

rgrunber · 2025-02-05T17:07:11Z

@gayanper I know it's been a while but I have revived this PR and addressed my main issue with it (mainly how the information was being displayed).

The first quick-pick is just the regular Go to Symbol in Editor... quick access. The second is a quick-pick I've created to look more or less the same as the previous (activated with ctrl+alt+o for now), but that supports inherited symbols, through the extended outline request you created in eclipse-jdtls/eclipse.jdt.ls#2173 . I've revived that PR and it needed only minimal changes (like opting to ignore java.lang.Object members).

extended-outline-quickpick.mp4

If this approach looks good, let me know and I can proceed with it. There's still a bit of polish needed but I really like the responsive way this approach permits, that the reference view just didn't quite have. We can always restore the reference view approach down the road if truly desired.

gayanper · 2025-02-06T20:06:50Z

@rgrunber This looks promising, feel free to take over this PR and continue since I'm busy with some other things and I have very less time to work on Java things right now.

rgrunber · 2025-02-07T16:53:39Z

Fixes Go to symbol in Editor should have a way to include inherited symbols #2342
Requires Support for inherited document symbols. eclipse-jdtls/eclipse.jdt.ls#3378

    Support viewing inherited members through QuickPick UI.
    
    - The QuickPick view API is used to show the document outline with
      inherited symbols using the new language server extension method,
      'java/extendedDocumentSymbols'.

Accessible through the command palette with the command Java: Open Extended Outline, and also bound to ctrl+alt+o

extended-document-symbols.mp4

The outline view has a yellow selection highlight so I might look to see if there's a way to mimic that.

rgrunber · 2025-02-10T18:04:17Z

I made it so that the extended outline can be triggered by hitting ctrl+o once the "Go To Symbol In Workspace .. " (ctrl+o) quick-open is already up. In this way it functions like an "extended" view and makes more sense. Slight downside is I don't have a way to check that the command palette is showing a quick-access for document symbols, so it could also be activated on a regular command palette, but I can certainly check that the active editor is a Java language file. I feel this is "close enough".

Also, I think it's not really including default methods from interfaces but maybe we can fix that in future iterations.

gayanper · 2025-02-10T19:33:42Z

@rgrunber how about only triggering the command only if quick open is visible when clause is true ?

rgrunber · 2025-02-10T21:20:13Z

@gayanper , you mean make the check more accurate by trying programmatically (as opposed to from the when clause) ? That's something I hadn't considered but I can give it a quick try. The problem with the "when" clause is the closest thing to what I want is the context mode inQuickOpen, which only tells me the quick-open is open and has focus. The problem is that doesn't tell me whether it's set to look for commands (>), workspace symbols (#), or document symbols (@, what I want). I'll try the programmatic approach.

Update: I don't think this is possible. The closest was if I could override workbench.action.gotoSymbol but then I'd have to restore the previous state, which I can't seem to do, since I don't have a way to access the original registered function.

- The QuickPick view API is used to show the document outline with inherited symbols using the new language server extension method, 'java/extendedDocumentSymbol'. - When ctrl+o is activated from the quick-pick menu (eg. the outline view is already active), the extended outline is then activated Co-Authored-by: Gayan Perera <[email protected]> Co-Authored-by: Roland Grunberg <[email protected]>

gayanper force-pushed the extended_outline branch from 5033b82 to aa7b6e0 Compare July 22, 2022 14:09

gayanper force-pushed the extended_outline branch 2 times, most recently from dad7afa to 8d52ed3 Compare July 22, 2022 20:09

github-actions bot added the has conflicts label Sep 22, 2022

gayanper force-pushed the extended_outline branch from 75e11b9 to 9ec8a5a Compare November 20, 2022 19:45

jdneo reviewed Nov 22, 2022

View reviewed changes

github-actions bot added has conflicts and removed has conflicts labels Nov 24, 2022

rgrunber self-assigned this May 31, 2023

rgrunber mentioned this pull request Jan 20, 2025

how search all functions include extend parent class in current file #3910

Closed

rgrunber mentioned this pull request Feb 5, 2025

Go to symbol in Editor should have a way to include inherited symbols #2342

Closed

rgrunber force-pushed the extended_outline branch from 9ec8a5a to f69dad8 Compare February 7, 2025 16:49

rgrunber force-pushed the extended_outline branch from f69dad8 to 8ae0f56 Compare February 7, 2025 21:35

rgrunber linked an issue Feb 10, 2025 that may be closed by this pull request

Go to symbol in Editor should have a way to include inherited symbols #2342

Closed

rgrunber force-pushed the extended_outline branch from 8ae0f56 to b6286be Compare February 10, 2025 17:59

rgrunber removed the has conflicts label Feb 10, 2025

rgrunber changed the title ~~Add support to view inherited members #2342~~ Support viewing inherited members through QuickPick UI. Feb 11, 2025

rgrunber force-pushed the extended_outline branch from b6286be to a37e495 Compare February 12, 2025 17:09

rgrunber merged commit 907578a into redhat-developer:master Feb 12, 2025
2 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support viewing inherited members through QuickPick UI. #2590

Support viewing inherited members through QuickPick UI. #2590

gayanper commented Jul 22, 2022

gayanper commented Jul 22, 2022

jdneo commented Jul 27, 2022 •

edited

Loading

gayanper commented Jul 27, 2022

jdneo commented Jul 28, 2022

gayanper commented Jul 28, 2022

jdneo commented Jul 28, 2022 •

edited

Loading

gayanper commented Jul 31, 2022 •

edited

Loading

jdneo commented Aug 1, 2022

gayanper commented Aug 1, 2022

gayanper commented Aug 6, 2022

jdneo commented Aug 8, 2022

manojbaishya commented Aug 31, 2022

jdneo commented Sep 7, 2022

rgrunber commented Sep 8, 2022

manojbaishya commented Nov 20, 2022

jdneo commented Nov 22, 2022

jdneo Nov 22, 2022 •

edited

Loading

gayanper Nov 26, 2022

jdneo Nov 28, 2022

gayanper Nov 28, 2022

jdneo Nov 29, 2022

jdneo Nov 22, 2022

jdneo Nov 22, 2022

CsCherrYY Nov 22, 2022

gayanper commented Mar 26, 2023

jdneo commented Mar 27, 2023

manojbaishya commented May 4, 2023

rgrunber commented Feb 5, 2025

gayanper commented Feb 6, 2025

rgrunber commented Feb 7, 2025 •

edited

Loading

rgrunber commented Feb 10, 2025 •

edited

Loading

gayanper commented Feb 10, 2025

rgrunber commented Feb 10, 2025 •

edited

Loading

Support viewing inherited members through QuickPick UI. #2590

Support viewing inherited members through QuickPick UI. #2590

Conversation

gayanper commented Jul 22, 2022

gayanper commented Jul 22, 2022

jdneo commented Jul 27, 2022 • edited Loading

gayanper commented Jul 27, 2022

jdneo commented Jul 28, 2022

gayanper commented Jul 28, 2022

jdneo commented Jul 28, 2022 • edited Loading

gayanper commented Jul 31, 2022 • edited Loading

jdneo commented Aug 1, 2022

gayanper commented Aug 1, 2022

gayanper commented Aug 6, 2022

jdneo commented Aug 8, 2022

manojbaishya commented Aug 31, 2022

Eclipse

Outline View

Type Hierarchy (with "Show all inherited members" enabled)

Navigation from Type Hierarchy panel

Visual Studio Code

Outline and References: Class Hierarchy

Navigation from Class Hierarchy

jdneo commented Sep 7, 2022

rgrunber commented Sep 8, 2022

manojbaishya commented Nov 20, 2022

jdneo commented Nov 22, 2022

jdneo Nov 22, 2022 • edited Loading

Choose a reason for hiding this comment

gayanper Nov 26, 2022

Choose a reason for hiding this comment

jdneo Nov 28, 2022

Choose a reason for hiding this comment

gayanper Nov 28, 2022

Choose a reason for hiding this comment

jdneo Nov 29, 2022

Choose a reason for hiding this comment

jdneo Nov 22, 2022

Choose a reason for hiding this comment

jdneo Nov 22, 2022

Choose a reason for hiding this comment

CsCherrYY Nov 22, 2022

Choose a reason for hiding this comment

gayanper commented Mar 26, 2023

jdneo commented Mar 27, 2023

manojbaishya commented May 4, 2023

rgrunber commented Feb 5, 2025

gayanper commented Feb 6, 2025

rgrunber commented Feb 7, 2025 • edited Loading

rgrunber commented Feb 10, 2025 • edited Loading

gayanper commented Feb 10, 2025

rgrunber commented Feb 10, 2025 • edited Loading

jdneo commented Jul 27, 2022 •

edited

Loading

jdneo commented Jul 28, 2022 •

edited

Loading

gayanper commented Jul 31, 2022 •

edited

Loading

jdneo Nov 22, 2022 •

edited

Loading

rgrunber commented Feb 7, 2025 •

edited

Loading

rgrunber commented Feb 10, 2025 •

edited

Loading

rgrunber commented Feb 10, 2025 •

edited

Loading