Goto buffer #4756

Elias-Graf · 2022-11-15T11:24:09Z

Implemented a command to go to a specific buffer by index.

Command: buffer-goto <i>
Alias: b <i>

Inlined some functions, that had their origin in old implementation detail, and are now unnecessary.

Now able to go to specific buffers by pressing CTRL+<[1-9]>.

helix-term/src/commands.rs

the-mikedavis · 2022-11-16T01:35:02Z

helix-term/src/commands.rs

+fn goto_first_buffer(cx: &mut Context) {
+    goto_buffer_by_idx_impl(cx.editor, 0);
+}
+
+fn goto_second_buffer(cx: &mut Context) {
+    goto_buffer_by_idx_impl(cx.editor, 1);
+}
+
+fn goto_third_buffer(cx: &mut Context) {
+    goto_buffer_by_idx_impl(cx.editor, 2);
+}
+
+fn goto_fourth_buffer(cx: &mut Context) {
+    goto_buffer_by_idx_impl(cx.editor, 3);
+}
+
+fn goto_fifth_buffer(cx: &mut Context) {
+    goto_buffer_by_idx_impl(cx.editor, 4);
+}
+
+fn goto_sixth_buffer(cx: &mut Context) {
+    goto_buffer_by_idx_impl(cx.editor, 5);
+}
+
+fn goto_seventh_buffer(cx: &mut Context) {
+    goto_buffer_by_idx_impl(cx.editor, 6);
+}
+
+fn goto_eight_buffer(cx: &mut Context) {
+    goto_buffer_by_idx_impl(cx.editor, 7);
+}
+
+fn goto_ninth_buffer(cx: &mut Context) {
+    goto_buffer_by_idx_impl(cx.editor, 8);
+}


If this were a command, it should be implemented as a single command that uses cx.count() for the buffer number. I don't think that adding another command is necessary though: you can add the bindings you're after with just the typable command like so:

[keys.normal] "C-1" = ":b 1" "C-2" = ":b 2" # ...

This is much cleaner. But the only location I could (relevantly) find "keys.normal" was in book/src/remapping.md. Does that mean there shouldn't keybindings by default? If yes, I have to disagree, as this is such an essential feature. Maybe I am using something incorrectly?

How would I use cx.count(), or better, how is count "provided"?.

Returns 1 if no explicit count was provided

I seem to always get 1, probably I'm not using it correctly.

We have typable variants of the pipe commands, so there's precedence. You can have a typable version, and another version that utilizes cx.count(). As keybindings can be customizable, it's a bit ugly to work around that to support it in the default config.

helix-term/src/commands.rs

helix-term/src/commands/typed.rs

the-mikedavis · 2022-11-16T01:47:36Z

helix-term/src/commands.rs

-fn goto_buffer(editor: &mut Editor, direction: Direction) {
-    let current = view!(editor).doc;


I don't think it's necessary to change the body of the old goto_buffer function - it has the same behavior before and after except that going to the previous buffer skips from the opposite direction

I mainly replaced the body of the function because I saw nearly identical code in both branches of the match statement. That just triggered my refactoring sense, lol.
After looking into it, using an iterator the way it is used here may be hard to understand / overkill for such a simple task.

except that going to the previous buffer skips from the opposite direction

I'm honestly not certain what you mean by this. buffer-next goes "to the right", and buffer-previous goes "to the left". Have I missed something that the original implementation does?

helix-term/src/commands/typed.rs

Previously collected into a vector, and then indexed that.

QiBaobin · 2022-11-16T10:19:47Z

can we add this only to command so that we can take advantage of cx.count()? Regarding typable commands, I think it would be better to support name and path too . #4771

Elias-Graf · 2022-11-16T10:33:02Z

@QiBaobin I haven't yet figured out how cx.count() works. This has already been suggested in the reviews above, and I'm working on it. I don't have too much time on my hands during the day, so I will most likely get to it in the evening.

Regarding using the buffer name instead of the buffer ID (I assume you mean index, because the ID is different AFAIK). I think that doesn't really work, since two buffers can be named the same thing. For example, I was testing with multiple [scratch] buffers. In addition, you can already quickly switch between them by typing space+ b and then the name of your buffer (path also already works). I'm specifically implementing this, so I can use a shortcut (I'm hoping for ctrl + [1-9]) to switch between tabs (buffers). I heavily utilize this in my workflow, where for example components have multiple relevant files (e.g. HTML, CSS, TS), or I'm switching back and forth between implementation and spec / unit test.

I appreciate any suggestions and ideas relevant to this pull request :)

QiBaobin · 2022-11-16T10:45:11Z

@QiBaobin I haven't yet figured out how cx.count() works. This has already been suggested in the reviews above, and I'm working on it. I don't have too much time on my hands during the day, so I will most likely get to it in the evening.

Regarding using the buffer name instead of the buffer ID (I assume you mean index, because the ID is different AFAIK). I think that doesn't really work, since two buffers can be named the same thing. For example, I was testing with multiple [scratch] buffers. In addition, you can already quickly switch between them by typing space+ b and then the name of your buffer (path also already works). I'm specifically implementing this, so I can use a shortcut (I'm hoping for ctrl + [1-9]) to switch between tabs (buffers). I heavily utilize this in my workflow, where for example components have multiple relevant files (e.g. HTML, CSS, TS), or I'm switching back and forth between implementation and spec / unit test.

I appreciate any suggestions and ideas relevant to this pull request :)

@Elias-Graf Good point. I recommend use name or path as I want to bind a key to do something like scatchpad, will would launch one specific buffer like scratch or terminal very quick.

Regarding cx.count(), you can get it in a function defined in src/commands.rs. It would work like that: you type number first then the key you bind to that function for example C-b. So that 1 C-b would take you to the first buffer, 2 C-b would be the second etc.

Elias-Graf · 2022-11-16T10:49:00Z

@QiBaobin ohhh, thanks for telling me that. I bet it would have been ages until I figured that out. Sadly, this isn't really in-line with browsers / file explorers / terminals / other editors (maybe also see: #475 (comment)), which can be frustrating to use because the functionality is essentially the same :/

QiBaobin · 2022-11-16T10:56:17Z

@QiBaobin ohhh, thanks for telling me that. I bet it would have been ages until I figured that out. Sadly, this isn't really in-line with browsers / file explorers / terminals / other editors (maybe also see: #475 (comment)), which can be frustrating to use because the functionality is essentially the same :/

@Elias-Graf Then we only need add a TypableCommand to accept the argument, we don't need touch commands.rs, just bind keys in the default config or our own config file to use them like C-1 = "buffer 1" etc.

However, I still think it's better to support name and path too, can you add them so that I can close my PR? If you don't have time, I can copy your logic to my PR.

Elias-Graf · 2022-11-16T11:02:51Z

@QiBaobin I will place them into the default config once I find it :P.

I'll see about the buffer name / path once I'm done with the things mentioned in the review. I would also appreciate the feedback of members / maintainers on this specifically (maybe @kirawi or @the-mikedavis). I personally don't see the use case (yet? :D), but I'm happy to add it if it's generally desired.

Some questions that come into mind:

What order would the evaluation be in?
What order would the completions be in?
What happens if a buffer is named 1?

#4393 might be relevant depending on answers to those questions (and how the renaming is implemented).

Elias-Graf · 2022-11-16T14:59:34Z

@QiBaobin Would be so kind and tell me where to do this:

just bind keys in the default config or our own config file to use them like C-1 = "buffer 1" etc.

I'm only able to find helix-term/src/keymap/default.rs, which, as far as my testing goes, does not support adding things like "C-1" => ":b1". I also found relevant text in the book book/src/remapping.md... which only talks about adjusting the local configuration.

QiBaobin · 2022-11-21T04:29:31Z

@QiBaobin Would be so kind and tell me where to do this:

just bind keys in the default config or our own config file to use them like C-1 = "buffer 1" etc.

I'm only able to find helix-term/src/keymap/default.rs, which, as far as my testing goes, does not support adding things like "C-1" => ":b1". I also found relevant text in the book book/src/remapping.md... which only talks about adjusting the local configuration.

After looking at the code, it turned out we don't have any global config file like languages.toml yet, maybe we can create one so that we don't need write functions for every key.

icefoxen · 2023-02-20T18:36:14Z

I think that doesn't really work, since two buffers can be named the same thing.

Poking my head in 'cause I was about to try to implement this anyway... iirc other editors suffix duplicate buffer names with a number when this happens, so if you have a buffer foo.txt then it's just called foo.txt, but if you open another buffer foo.txt then it is named foo.txt <2> or such. To me this seems nice because it lets you just use names in the common case of no duplicate names.

pascalkuthe · 2024-04-11T23:42:28Z

Closing this as stale. The vuffer picker and "gui like" order tabs workflow is not really a priority for us so I don't see us going forward with this.

Thank you for contributing!

= added 2 commits November 15, 2022 12:19

Implemented "goto-buffer" command

f3bfb8b

Merge branch 'master' into goto-buffer

6f54f7d

Elias-Graf mentioned this pull request Nov 15, 2022

Add commands for number-based buffer switching #475

Closed

Inlined some functions

c156b42

Inlined some functions, that had their origin in old implementation detail, and are now unnecessary.

kirawi added A-helix-term Area: Helix term improvements S-waiting-on-review Status: Awaiting review from a maintainer. labels Nov 15, 2022

= added 2 commits November 15, 2022 22:31

Added documentation for goto-buffer command

92e49e1

Added shortcut for going to buffers

a7c5b9f

Now able to go to specific buffers by pressing CTRL+<[1-9]>.

the-mikedavis reviewed Nov 16, 2022

View reviewed changes

= added 2 commits November 16, 2022 07:29

Removed abbreviations like "idx" and "curr"

1357ac6

Now using Iterator::nth

4bf9e14

Previously collected into a vector, and then indexed that.

= added 3 commits November 16, 2022 15:31

Now completing the buffer names

fa8c7ab

Now returning err on invalid indices

50747e4

Renamed "buffer <i>" to "buffer number <n>" in doc

b474ab7

QiBaobin mentioned this pull request Nov 21, 2022

add buffer command so that we can bind key to switch buffers #4771

Closed

bindsdev mentioned this pull request Jan 14, 2023

Command to switch to named buffer #5525

Closed

gabydd mentioned this pull request Sep 7, 2023

Goto buffer by num #8198

Closed

pascalkuthe closed this Apr 11, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Goto buffer #4756

Goto buffer #4756

Elias-Graf commented Nov 15, 2022

the-mikedavis Nov 16, 2022

Elias-Graf Nov 16, 2022

kirawi Nov 16, 2022 •

edited

Loading

the-mikedavis Nov 16, 2022

Elias-Graf Nov 16, 2022

QiBaobin commented Nov 16, 2022 •

edited

Loading

Elias-Graf commented Nov 16, 2022 •

edited

Loading

QiBaobin commented Nov 16, 2022 •

edited

Loading

Elias-Graf commented Nov 16, 2022

QiBaobin commented Nov 16, 2022 •

edited

Loading

Elias-Graf commented Nov 16, 2022 •

edited

Loading

Elias-Graf commented Nov 16, 2022 •

edited

Loading

QiBaobin commented Nov 21, 2022

icefoxen commented Feb 20, 2023 •

edited

Loading

pascalkuthe commented Apr 11, 2024

		fn goto_buffer(editor: &mut Editor, direction: Direction) {
		let current = view!(editor).doc;

Goto buffer #4756

Goto buffer #4756

Conversation

Elias-Graf commented Nov 15, 2022

the-mikedavis Nov 16, 2022

Choose a reason for hiding this comment

Elias-Graf Nov 16, 2022

Choose a reason for hiding this comment

kirawi Nov 16, 2022 • edited Loading

Choose a reason for hiding this comment

the-mikedavis Nov 16, 2022

Choose a reason for hiding this comment

Elias-Graf Nov 16, 2022

Choose a reason for hiding this comment

QiBaobin commented Nov 16, 2022 • edited Loading

Elias-Graf commented Nov 16, 2022 • edited Loading

QiBaobin commented Nov 16, 2022 • edited Loading

Elias-Graf commented Nov 16, 2022

QiBaobin commented Nov 16, 2022 • edited Loading

Elias-Graf commented Nov 16, 2022 • edited Loading

Elias-Graf commented Nov 16, 2022 • edited Loading

QiBaobin commented Nov 21, 2022

icefoxen commented Feb 20, 2023 • edited Loading

pascalkuthe commented Apr 11, 2024

kirawi Nov 16, 2022 •

edited

Loading

QiBaobin commented Nov 16, 2022 •

edited

Loading

Elias-Graf commented Nov 16, 2022 •

edited

Loading

QiBaobin commented Nov 16, 2022 •

edited

Loading

QiBaobin commented Nov 16, 2022 •

edited

Loading

Elias-Graf commented Nov 16, 2022 •

edited

Loading

Elias-Graf commented Nov 16, 2022 •

edited

Loading

icefoxen commented Feb 20, 2023 •

edited

Loading