Skip to content

Focus the main view #4429

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 16 commits into
base: master
Choose a base branch
from
Open

Focus the main view #4429

wants to merge 16 commits into from

Conversation

stefanhaller
Copy link
Collaborator

  • PR Description

This adds a new 0 keybinding to the side panels that focuses whatever main view is currently displayed, with the goal of making it easier to scroll the main view (using the normal navigation keys , . < >), and being able to search the main view using /.

Alternatively to pressing 0 you can also click the main view to focus it. Note that previously it was possible to go directly to the staging panel by clicking in the main view when a file was selected; this now takes a double click, because the first click just focuses the main view, but you can go to staging from there by clicking again.

I'm reasonably happy with the overall behavior, but it takes some getting used to, so we'll want to test this for a while to see if it doesn't make the focus handling too confusing.

Also, it works best when using a pager, because then you get a very clear visual distinction between the focused main view and the staging view. Without a pager they look identical, so it can be confusing when you select a file, click in the main view, see something that looks like the staging panel, and then nothing happens when you press space to stage hunks. Maybe we should consider jumping directly to staging when no pager is used, to make this less confusing. (But note that this situation will change again if/when we manage to get #4332 working.)

Fixes #3988.

  • Please check if the PR fulfills these requirements
  • Cheatsheets are up-to-date (run go generate ./...)
  • Code has been formatted (see here)
  • Tests have been added/updated (see here for the integration test guide)
  • Text is internationalised (see here)
  • If a new UserConfig entry was added, make sure it can be hot-reloaded (see here)
  • Docs have been updated if necessary
  • You've read through your own file changes for silly mistakes etc

@stefanhaller stefanhaller added the enhancement New feature or request label Mar 26, 2025
@codacy-production Codacy Production
Copy link

codacy-production bot commented Mar 26, 2025 •
edited
Loading

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
Report missing for 5f809801 ✅ 62.73%
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (5f80980) Report Missing Report Missing Report Missing
Head commit (b51fdb7) 54694 47337 86.55%

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details
Coverable lines Covered lines Diff coverage
Pull request (#4429) 381 239 62.73%

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

Footnotes

  1. Codacy didn't receive coverage data for the commit, or there was an error processing the received data. Check your integration for errors and validate that your coverage setup is correct. ↩

@stefanhaller
Copy link
Collaborator Author

Input from @jesseduffield:

I'm not clear on the value of having a cursor in the view. I would have expected that up/down would just scroll, similar to when you're in a less pager.

Having a cursor is mainly motivated by #3986; that issue talks mostly about clicking in the view, but I would find it useful to have the same functionality when hitting enter in the focused main view. For example, select a commit, focus it, move through it with . or arrow-down, and hit enter to go into patch building. Or e to edit the file at the selected line. I have a rough draft PR for this at #3985, but it only works for clicking. I should rebase that branch onto this one so that you get a sense of what it feels like to hit enter in the focused main view, but that's a bit of work and I'm not sure I'll have time for this today.

Of course, as long as we don't have #3986 (and it's not clear we ever will, since it depends on support from the pager), you are right that a cursor makes little sense. And in views other than diffs (e.g. branch log) it never does.

Options:

  1. Keep the cursor in anticipation of 3986, and live with the strangeness for now. (Maybe forever if we never get around to it.)
  2. Remove the cursor highlight for now and only add it when we do 3986. The behavior change might be confusing then.
  3. Don't merge this PR now, only do it if we have solved 3986 and do both together.

Even with 3986, it will only work when using a pager that supports whatever custom protocol we come up with, so maybe we still need to make the cursor an opt-in config.

@stefanhaller
Copy link
Collaborator Author

I rebased #3985 onto this PR now, so it now works when pressing enter in the focused view. (Pressing e is not supported yet.)

@stefanhaller stefanhaller mentioned this pull request Mar 28, 2025
Draft
@stefanhaller
Copy link
Collaborator Author

@jesseduffield As discussed privately, in this PR we no longer show a cursor highlight in the focused main view. We do this in the followup PR (#3985), but only with an opt-in user config.

This is now almost ready, except that I need to find a way to block until all view content has been read from the task when pressing > (or end); also, there are strange bugs with searching that I need to figure out. Keeping as draft for now.

@stefanhaller stefanhaller mentioned this pull request Apr 3, 2025
Closed
@stefanhaller
Copy link
Collaborator Author

I consider this ready now, opening for review.

@stefanhaller stefanhaller marked this pull request as ready for review April 3, 2025 16:19
@stefanhaller
[gocui] Make highlight overwrite the background color
154c16b 
It seems that highlighting has so far only been used in cases where there wasn't
a background color. Or'ing the bits of the color with the existing background
color doesn't make sense.
@stefanhaller
Remove utils.Clamp, use lo.Clamp instead
2bfad5a
@stefanhaller
Add IGuiCommon.GetViewBufferManagerForView
9f23c95 
So that we don't have to pass the map to controllers.
@stefanhaller
Always render diffs to the main/secondary context pair, even for files
f15be32 
Previously we would render the diff for a directory to the main/secondary pair,
but a diff for a file to the staging/stagingSecondary pair. (And similar for
commit files: main/secondary for directories, but
patchBuilding/patchBuildingSecondary for files.)

I always found this confusing and couldn't really understand why we are doing
this; but now it gets in my way because I want to attach a controller to
main/secondary so that they can be focused. So change it to always use the main
context pair for everything we render from a side panel.
@stefanhaller
Add class MainContext
75bd888 
In this state of the code it isn't worth much because it's not any more than a
SimpleContext, but we'll add things to it later in the branch.
@stefanhaller
Allow focussing the main view
2ac3e8b 
In this commit this is only possible by pressing '0' in a side panel; we'll add
mouse clicking later in the branch.

Also, you can't really do anything in the focused view except press escape to
leave it again. We'll add some more functionality in a following commit.
@stefanhaller
Update keybindings, config docs, and schema
0b85db1
@stefanhaller
Add navigation keybindings to focused main view
da786fc
@stefanhaller
Use readLines channel only for command tasks
51037c5 
And only while the task is running.

This avoids accumulating lots of blocked goroutines when scrolling a view down
more than 1024 times (the capacity of the readLines channel).
@stefanhaller
Read all lines from task when jumping to bottom
e8ef9b0
@stefanhaller
Make the main view searchable
9058a40
@stefanhaller
Read all lines from task when starting to search
4049149
@stefanhaller
Allow clicking in main view to focus it
755b90b
@stefanhaller
Allow clicking in focused main view to go to staging
8eb35e2 
Only works if a file is selected.
@stefanhaller
Allow clicking in the respective other main view to switch focus to it
d13d627
@stefanhaller
Re-render focused main view on refresh if needed
b51fdb7
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Allow focusing the main view
1 participant
@stefanhaller