Implement call hierarchy request #2151

jwortmann · 2022-12-26T11:13:23Z

There is no Sublime API to visualize and interact with a tree structure, like for example the folders and files in the sidebar. So I made my own implementation for that, using a HtmlSheet. Let me know what you think!

It can be tested e.g. with LSP-pyright:

call_hierarchy.webm

For now only with "incoming calls" (which is quite similar to "Find References"), but just due to lack of a good solution how a toggle or so can be represented in the UI. VSCode has a small button to change between incoming/outgoing calls.

The "TreeView" is a quite generic implementation (inspired by the VSCode API). So it should be straightforward to reuse it for the "type hierarchy" request, but I haven't tested that because I don't know which language server supports type hierarchy requests.

Closes #1429.

rchl · 2022-12-26T22:53:30Z

Nice!
For now just one initial feedback after quick testing that the initial expand should be done automatically as this is the point of opening it in the first place.

jwortmann · 2022-12-27T09:31:43Z

The first item is expanded now, and I added a toggle button to switch between incoming / outgoing calls.

Not sure what's going on with the CI. The lint errors seem to be completely unrelated to this PR. But I don't get those errors on the main branch...
If you merge my other PR, I can rebase on main and see if I can fix them.

jwortmann · 2022-12-27T09:41:57Z

My OS, doesn't recognise ⏵ or ⏷ (12.2.1 On MacOS 12.2.1)

Oh, I see. I think it uses the code font for these characters, i.e. the font you configured in Preferences.sublime-settings. And it seems those characters are not supported by this font. I guess we can try to set the "system" font for them, and then see if the arrows are rendered correctly.

One other thing, Currently when I click a node, it will take me to the Location and close the Call Hierarchy. I will just see one file.

I would rather open a side by side view. That way I could still see the Call Hierarchy and click other Locations, to have a better look how they are called.

Yeah I had this in mind already, but haven't tried it yet. I wonder whether there is a way to open the new tab to the left of the "Call Hierarchy" sheet. So that the call hierarchy sheet will always be the rightmost tab.
But it doesn't look bad in your recording.

plugin/core/tree_view.py

plugin/core/registry.py

rchl · 2022-12-27T13:20:29Z

General note: The "Incoming" / "Outgoing" naming from the spec is IMO not very easy to understand. I think we could adopt the VSCode naming which uses "Callers of" / "Calls from".

rchl · 2022-12-27T22:53:41Z

(BTW. Adding support for Call Hierarchy in typescript-language-server/typescript-language-server#649 also)

plugin/call_hierarchy.py

rchl

Since we are OK with this approach, it would be nice if you could also add some bits about it to documentation (at least the new command name) and maybe add to main menu if relevant to you.

rchl · 2022-12-29T23:03:10Z

boot.py

@@ -190,27 +195,39 @@ def on_post_window_command(self, window: sublime.Window, command_name: str, args
                sublime.set_timeout(panel_manager.update_log_panel)


-class LspOpenLocationCommand(sublime_plugin.TextCommand):
+class LspOpenLocationCommand(LspWindowCommand):


I found two places that ran this command on the view:

https://github.com/sublimelsp/LSP-volar/blob/32f0c42ecf2d10036a913518938a91d704c809f1/plugin.py#L69-L69

https://github.com/sublimelsp/LSP-typescript/blob/e6ae40de6c3322fbe064698ff49f958ab6b3e4f9/commands.py#L35-L35

Not a priority but we should remember to fix those around the same time.

boot.py

plugin/call_hierarchy.py

plugin/core/tree_view.py

boot.py

plugin/call_hierarchy.py

plugin/core/registry.py

plugin/core/protocol.py

plugin/core/open.py

* main: workaround for View Listeners not being attached for new transient view (sublimelsp#2174) Make Document Symbols behavior more consistent with built-in Goto Symbol (sublimelsp#2166) docs: fsautocomplete config - remove redundant argument (sublimelsp#2165) Allow missing window/workDoneProgress/create request from the server (sublimelsp#2159) Use "plaintext" language ID for plain text files (sublimelsp#2164) Improve type annotations (sublimelsp#2162) Don't use "escapeall" extension when formatting with mdpopups (sublimelsp#2163)

* origin/main: feat(API): allow setting additional text in permanent server status (#2173) Implement call hierarchy request (#2151) workaround for View Listeners not being attached for new transient view (#2174)

* main: (80 commits) Perform inlay hint action on double instead of single click (#2175) support canceling pending completions request (#2177) Implement type hierarchy request (#2180) fix stale state or lack of updates on changing branches (#2182) Add timestamp and request duration in LSP logs (#2181) don't show diagnostics panel on save by default (#2179) trigger "on_server_response_async" also for "initialize" response (#2172) feat(API): allow setting additional text in permanent server status (#2173) Implement call hierarchy request (#2151) workaround for View Listeners not being attached for new transient view (#2174) Make Document Symbols behavior more consistent with built-in Goto Symbol (#2166) docs: fsautocomplete config - remove redundant argument (#2165) Allow missing window/workDoneProgress/create request from the server (#2159) Use "plaintext" language ID for plain text files (#2164) Improve type annotations (#2162) Don't use "escapeall" extension when formatting with mdpopups (#2163) Cut 1.21.0 Fix inlay hint parts wrapping into multiple lines (#2153) Ensure commands triggered from minihtml run on correct view (#2154) Add "Source Action" entry to the "Edit" main menu (#2149) ...

Implement call hierarchy request

09ad38c

jwortmann added 3 commits December 27, 2022 04:20

Expand root, better tooltip, decrease padding

865a93d

Add toggle button

4a472b8

Cleanup

6140630

This comment was marked as resolved.

Sign in to view

This comment was marked as outdated.

Sign in to view

jwortmann added 4 commits December 27, 2022 12:24

Merge branch 'main' into call-hierarchy

9c8ee61

Use different arrow symbols

7420ab6

Fix weird lint errors

f59e38c

And GitHub CI too

f356103

rchl reviewed Dec 27, 2022

View reviewed changes

plugin/core/tree_view.py Outdated Show resolved Hide resolved

rchl reviewed Dec 27, 2022

View reviewed changes

plugin/core/registry.py Show resolved Hide resolved

jwortmann added 2 commits December 27, 2022 13:19

Use Unicode characters instead of html entities for arrow symbols

8c02c57

Fix erroneous capability restriction

ec84c88

jwortmann added 2 commits December 27, 2022 19:21

Adjust labels

7b586fe

Add opened files to selection

df7ef69

predrag-codetribe reviewed Dec 28, 2022

View reviewed changes

plugin/call_hierarchy.py Outdated Show resolved Hide resolved

Adjust variable name

67bf89a

rchl mentioned this pull request Dec 29, 2022

Clickable list of variables, functions, classes and methods of the file sublimehq/sublime_text#5765

Open

jwortmann added 3 commits December 29, 2022 17:50

Derive from modifier keys whether add new tab to selection

3d85e4c

Fix missed renamed argument name

ef01161

Add call hierarchy to command palette

d31526f

jwortmann marked this pull request as ready for review December 29, 2022 17:17

rchl reviewed Dec 29, 2022

View reviewed changes

rchl reviewed Dec 30, 2022

View reviewed changes

boot.py Show resolved Hide resolved

Remove obsolete function

a4799c1

jwortmann commented Dec 30, 2022

View reviewed changes

boot.py Outdated Show resolved Hide resolved

This was referenced Dec 30, 2022

Run lsp_open_location command on a window sublimelsp/LSP-typescript#185

Merged

Run lsp_open_location command on a window sublimelsp/LSP-volar#153

Merged

jwortmann added 5 commits January 4, 2023 13:09

Simpler way to silence pyright

20d4343

Simplify and better variable name

cadb53a

Move LspOpenLocationCommand to core/registry.py

b93fd28

Tweak path formatting in tooltip

7739774

Missed to remove an obsolete import

7f57405

rchl reviewed Jan 4, 2023

View reviewed changes

plugin/call_hierarchy.py Outdated Show resolved Hide resolved

rchl mentioned this pull request Jan 4, 2023

Don't use "escapeall" extension when formatting with mdpopups #2163

Merged

rchl closed this in #2163 Jan 5, 2023

rchl reopened this Jan 5, 2023

rchl mentioned this pull request Jan 5, 2023

No replacement provided for "Find Callers" (but should be one available?) sublimelsp/LSP-typescript#186

Closed

rchl reviewed Jan 14, 2023

View reviewed changes

plugin/call_hierarchy.py Show resolved Hide resolved

rchl reviewed Jan 14, 2023

View reviewed changes

plugin/core/registry.py Show resolved Hide resolved

jwortmann added 2 commits January 22, 2023 14:16

Always open links in side-by-side mode

0e4298d

Tweak function name

1f3048f

rchl reviewed Jan 22, 2023

View reviewed changes

plugin/core/protocol.py Outdated Show resolved Hide resolved

rchl added 2 commits January 22, 2023 17:09

workaround bug with view listeners not being initialized

12ce27a

more specific workaround

d1950b6

predragnikolic reviewed Jan 22, 2023

View reviewed changes

plugin/core/open.py Outdated Show resolved Hide resolved

rchl added 2 commits January 22, 2023 20:59

add progress

45cad3a

rchl approved these changes Jan 22, 2023

View reviewed changes

rchl merged commit ba5aba3 into sublimelsp:main Jan 22, 2023

jwortmann deleted the call-hierarchy branch January 23, 2023 12:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement call hierarchy request #2151

Implement call hierarchy request #2151

jwortmann commented Dec 26, 2022 •

edited

Loading

rchl commented Dec 26, 2022

This comment was marked as resolved.

jwortmann commented Dec 27, 2022

jwortmann commented Dec 27, 2022

This comment was marked as resolved.

This comment was marked as outdated.

rchl commented Dec 27, 2022

rchl commented Dec 27, 2022

rchl left a comment

rchl Dec 29, 2022 •

edited

Loading

Implement call hierarchy request #2151

Implement call hierarchy request #2151

Conversation

jwortmann commented Dec 26, 2022 • edited Loading

rchl commented Dec 26, 2022

This comment was marked as resolved.

jwortmann commented Dec 27, 2022

jwortmann commented Dec 27, 2022

This comment was marked as resolved.

This comment was marked as outdated.

rchl commented Dec 27, 2022

rchl commented Dec 27, 2022

rchl left a comment

Choose a reason for hiding this comment

rchl Dec 29, 2022 • edited Loading

Choose a reason for hiding this comment

jwortmann commented Dec 26, 2022 •

edited

Loading

rchl Dec 29, 2022 •

edited

Loading