bug#75141: [PATCH] Add button navigation to treesit-explorer

bug#75141: [PATCH] Add button navigation to treesit-explorer

[Gabriel Santos via Bug reports for GNU Emacs, the Swiss army knife of text editors]

[-- Attachment #1: Type: text/plain, Size: 562 bytes --]


Greetings,

Currently, the only way to navigate through treesit-explorer is by the
use of C-n and C-p. Since this buffer is full of buttons, I decided to
add button navigation to it.

This patch adds button navigation to treesit-explorer, for the following
keys:

* forward-button
- f
- n
- TAB

* backward-button
- b
- p
- <backtab>

* Points of discussion

Maybe that's too many keys? The only ones I think that don't really fit
that much are "f" and "b", because they can also go down, but there's no
harm in having extra keys.

Regards,

--
Gabriel Santos


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: [PATCH] Add button navigation to treesit-explorer --]
[-- Type: text/x-patch, Size: 1135 bytes --]

From d78745581bdf7daf77602eb0bd06b6bdccc3c3c6 Mon Sep 17 00:00:00 2001
From: Gabriel Santos <gabrielsantosdesouza@disroot.org>
Date: Fri, 27 Dec 2024 10:43:20 -0300
Subject: [PATCH] Add button navigation to treesit-explorer

* lisp/treesit.el (treesit--explorer-tree-mode-map):
Define it as a child of special-mode-map, adding multiple
keys for button navigation.
---
 lisp/treesit.el | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/lisp/treesit.el b/lisp/treesit.el
index eb3e26fff7e..9925f8ee014 100644
--- a/lisp/treesit.el
+++ b/lisp/treesit.el
@@ -3907,6 +3907,17 @@ covers point.  PARSER-NAME are unique."
   "Mode for displaying syntax trees for `treesit-explore-mode'."
   nil)
 
+(defvar-keymap treesit--explorer-tree-mode-map
+  :doc "Keymap for the treesit tree explorer.
+Navigates from button to button."
+  :parent special-mode-map
+  "n" #'forward-button
+  "p" #'backward-button
+  "f" #'forward-button
+  "b" #'backward-button
+  "TAB" #'forward-button
+  "<backtab>" #'backward-button)
+
 (defun treesit-explorer-switch-parser (parser)
   "Switch explorer to use PARSER."
   (interactive
-- 
2.47.0

bug#75141: [PATCH] Add button navigation to treesit-explorer

[Eli Zaretskii]

> Date: Fri, 27 Dec 2024 10:54:04 -0300
> From:  Gabriel Santos via "Bug reports for GNU Emacs,
>  the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
> 
> Greetings,
> 
> Currently, the only way to navigate through treesit-explorer is by the
> use of C-n and C-p. Since this buffer is full of buttons, I decided to
> add button navigation to it.
> 
> This patch adds button navigation to treesit-explorer, for the following
> keys:
> 
> * forward-button
> - f
> - n
> - TAB
> 
> * backward-button
> - b
> - p
> - <backtab>
> 
> * Points of discussion
> 
> Maybe that's too many keys? The only ones I think that don't really fit
> that much are "f" and "b", because they can also go down, but there's no
> harm in having extra keys.

Thanks.

Yuan, any comments?

bug#75141: [PATCH] Add button navigation to treesit-explorer

[Yuan Fu]

> On Jan 4, 2025, at 3:57 AM, Eli Zaretskii <eliz@gnu.org> wrote:
> 
>> Date: Fri, 27 Dec 2024 10:54:04 -0300
>> From:  Gabriel Santos via "Bug reports for GNU Emacs,
>> the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
>> 
>> Greetings,
>> 
>> Currently, the only way to navigate through treesit-explorer is by the
>> use of C-n and C-p. Since this buffer is full of buttons, I decided to
>> add button navigation to it.
>> 
>> This patch adds button navigation to treesit-explorer, for the following
>> keys:
>> 
>> * forward-button
>> - f
>> - n
>> - TAB
>> 
>> * backward-button
>> - b
>> - p
>> - <backtab>
>> 
>> * Points of discussion
>> 
>> Maybe that's too many keys? The only ones I think that don't really fit
>> that much are "f" and "b", because they can also go down, but there's no
>> harm in having extra keys.
> 
> Thanks.
> 
> Yuan, any comments?

Sounds good! Though would using both f/b and n/p for the same thing a bit wasteful? Maybe we can start with n/p TAB/<backtab>?

Yuan

bug#75141: [PATCH] Add button navigation to treesit-explorer

[Gabriel Santos via Bug reports for GNU Emacs, the Swiss army knife of text editors]

>Sounds good! Though would using both f/b and n/p for the same thing a bit wasteful? Maybe we can start with n/p TAB/<backtab>?

Yes, that seems to be best, I'll update the patch now.

--
Gabriel Santos

bug#75141: [PATCH] Add button navigation to treesit-explorer

[Gabriel Santos via Bug reports for GNU Emacs, the Swiss army knife of text editors]

[-- Attachment #1: Type: text/plain, Size: 74 bytes --]


Here is the updated patch, with "f" and "b" removed.

--
Gabriel Santos


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: [PATCH] Add button navigation to treesit-explorer --]
[-- Type: text/x-patch, Size: 1078 bytes --]

From 1224d220985edd9de0731b26c0be96eb9f6b35a1 Mon Sep 17 00:00:00 2001
From: Gabriel Santos <gabrielsantosdesouza@disroot.org>
Date: Fri, 27 Dec 2024 10:43:20 -0300
Subject: [PATCH] Add button navigation to treesit-explorer

* lisp/treesit.el (treesit--explorer-tree-mode-map):
Define it as a child of special-mode-map,
adding keys for button navigation.
---
 lisp/treesit.el | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/lisp/treesit.el b/lisp/treesit.el
index e643eb48654..ef27a370bc2 100644
--- a/lisp/treesit.el
+++ b/lisp/treesit.el
@@ -4041,6 +4041,16 @@ covers point.  PARSER-NAME are unique."
   "Mode for displaying syntax trees for `treesit-explore-mode'."
   nil)
 
+(defvar-keymap treesit--explorer-tree-mode-map
+  :doc "Keymap for the treesit tree explorer.
+
+Navigates from button to button."
+  :parent special-mode-map
+  "n" #'forward-button
+  "p" #'backward-button
+  "TAB" #'forward-button
+  "<backtab>" #'backward-button)
+
 (defun treesit-explorer-switch-parser (parser)
   "Switch explorer to use PARSER."
   (interactive
-- 
2.47.1