Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Session.open_uri_async: Focus view when open file: URI #2079

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

LDAP
Copy link
Contributor

@LDAP LDAP commented Oct 5, 2022

Closes #2078

Session.open_uri_async focuses a view if there is a preexisting session buffer:

LSP/plugin/core/sessions.py

Lines 1487 to 1490 in 969a9c8

sb = self.get_session_buffer_for_uri_async(uri)
if sb:
view = sb.get_view_in_group(group)
self.window.focus_view(view)

or if the URI was opened using a plugin, since in this case the view was newly created:

LSP/plugin/core/sessions.py

Lines 1531 to 1534 in 969a9c8

def open_scratch_buffer(title: str, content: str, syntax: str) -> None:
if group > -1:
self.window.focus_group(group)
v = self.window.new_file(syntax=syntax, flags=flags)

However, when the URI starts with file: then the view is only focused if the file was previously not open.

Comment on lines +1511 to +1514
elif view:
window = view.window()
if window:
window.focus_view(view)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is one place in LSP code that exercises this branch and that's apply_workspace_edit_async. And in that case it makes more sense not to focus all views that are edited IMO.

I feel like there is some refactoring that is needed here to make this all easier to follow and know what to expect. Possibly there should be an explicit argument in all "open file" functions (and there is quite a few) to tell them what to do.

Copy link
Member

@rchl rchl Oct 8, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess one obstacle to make this more predictable is the fact that there is no way to open a new file and not give it focus...

Copy link
Contributor Author

@LDAP LDAP Oct 9, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But that also means that there is currently no way to always focus the view with Session.open_uri_async, which is a quite common use case in my opinion. (for file uris at least)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe apply_workspace_edit_async shouldn't call Session.open_uri_async at all since that is not what I would expect from the method name. I may attempt a refactoring in that regard once I got some spare time.

Copy link
Member

@rchl rchl Oct 9, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But that also means that there is currently no way to always focus the view with Session.open_uri_async

I agree that there should be but it should likely be an opt-in and through explicit argument.

Maybe apply_workspace_edit_async shouldn't call Session.open_uri_async at all since that is not what I would expect from the method name.

We have to open the file to apply the edit.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

session.open_uri_async should always focus the view
2 participants