public inbox for gdb-patches@sourceware.org
 help / color / mirror / Atom feed
From: strager <strager.nds@gmail.com>
To: gdb-patches@sourceware.org
Subject: [PATCH] gdb/tui: add 'set tui mouse-events off' to restore mouse selection
Date: Fri, 27 Jan 2023 16:42:58 -0800	[thread overview]
Message-ID: <CAC-ggsEszq2WX7eZ_UdvgaBtM1YdnBFyJstr4Z0=BNW6VcMEEQ@mail.gmail.com> (raw)

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

From 991bf4f7c3d58cb8d8858cf4284c360719843350 Mon Sep 17 00:00:00 2001
From: "Matthew \"strager\" Glazar" <strager.nds@gmail.com>
Date: Fri, 27 Jan 2023 16:19:45 -0800
Subject: [PATCH] gdb/tui: add 'set tui mouse-events off' to restore mouse
 selection

Rationale:
I use the mouse with my terminal to select and copy text. In gdb, I use
the mouse to select a function name to set a breakpoint, or a variable
name to print, for example.

When gdb is compiled with ncurses mouse support, gdb's TUI mode
intercepts mouse events. Left-clicking and dragging, which would
normally select text, seems to do nothing. This means I cannot select
text using my mouse anymore. This makes it harder to set breakpoints,
print variables, etc.

Solution:
I tried to fix this issue by editing the 'mousemask' call to only enable
buttons 4 and 5. However, this still caused my terminal (gnome-terminal)
to not allow text to be selected. The only way I could make it work is
by calling 'mousemask (0, NULL);'. But doing so disables the mouse code
entirely, which other people might want.

I therefore decided to make a setting in gdb called 'tui mouse-events'.
If enabled (the default), the behavior is as it is now: terminal mouse
events are given to gdb, disabling the terminal's default behavior.
If disabled (opt-in), the behavior is as it was before the year 2020:
terminal mouse events are not given to gdb, therefore the mouse can be
used to select and copy text.

Notes:
I am not attached to the setting name or its description. Feel free to
suggest better wording.

Testing:
I tested this change in gnome-terminal by performing the following steps
manually:

1. Run: gdb --args ./myprogram
2. Enable TUI: press ctrl-x ctrl-a
3. Click and drag text with the mouse. Observe no selection.
4. Input: set tui mouse-events off
5. Click and drag text with the mouse. Observe that selection works now.
6. Input: set tui mouse-events on
7. Click and drag text with the mouse Observe no selection.
---
 gdb/NEWS            |  7 +++++++
 gdb/doc/gdb.texinfo | 13 +++++++++++++
 gdb/tui/tui-io.c    |  3 ++-
 gdb/tui/tui-win.c   | 24 ++++++++++++++++++++++++
 gdb/tui/tui-win.h   |  3 +++
 5 files changed, 49 insertions(+), 1 deletion(-)

diff --git gdb/NEWS gdb/NEWS
index 2bc1672632a..c14158e41b5 100644
--- gdb/NEWS
+++ gdb/NEWS
@@ -17,6 +17,13 @@ maintenance print record-instruction [ N ]
   prints how GDB would undo the N-th previous instruction, and if N is
   positive, it prints how GDB will redo the N-th following instruction.

+set tui mouse-events [on|off]
+show tui mouse-events
+  When on (default), the TUI will interpret mouse clicks (including
scroll wheel
+  presses), overwriting the terminal's default behavior (usually text
+  selection). When off, the TUI will preserve the terminal's default behavior
+  for mouse events.
+
 * MI changes

 ** mi now reports 'no-history' as a stop reason when hitting the end of the
diff --git gdb/doc/gdb.texinfo gdb/doc/gdb.texinfo
index b5fad2cb16e..c36c24273d3 100644
--- gdb/doc/gdb.texinfo
+++ gdb/doc/gdb.texinfo
@@ -29867,6 +29867,19 @@ source text at the next tab stop; the compact
display uses only as
 much space as is needed for the line numbers in the current file, and
 only a single space to separate the line numbers from the source.

+@item set tui mouse-events @r{[}on@r{|}off@r{]}
+@kindex set tui mouse-events
+When on (default), the TUI will interpret mouse clicks (including scroll wheel
+presses), overwriting the terminal's default behavior (usually text selection).
+When off, the TUI will preserve the terminal's default behavior for mouse
+events.
+
+Set whether the TUI source window is displayed in ``compact'' form.
+The default display uses more space for line numbers and starts the
+source text at the next tab stop; the compact display uses only as
+much space as is needed for the line numbers in the current file, and
+only a single space to separate the line numbers from the source.
+
 @kindex set debug tui
 @item set debug tui @r{[}on|off@r{]}
 Turn on or off display of @value{GDBN} internal debug messages relating
diff --git gdb/tui/tui-io.c gdb/tui/tui-io.c
index a17cf38a1f2..45ef34aeab5 100644
--- gdb/tui/tui-io.c
+++ gdb/tui/tui-io.c
@@ -655,7 +655,8 @@ static void
 tui_prep_terminal (int notused1)
 {
 #ifdef NCURSES_MOUSE_VERSION
-  mousemask (ALL_MOUSE_EVENTS, NULL);
+  if (tui_enable_mouse)
+    mousemask (ALL_MOUSE_EVENTS, NULL);
 #endif
 }

diff --git gdb/tui/tui-win.c gdb/tui/tui-win.c
index 008189eb99b..5709bfcbac1 100644
--- gdb/tui/tui-win.c
+++ gdb/tui/tui-win.c
@@ -897,6 +897,17 @@ tui_show_compact_source (struct ui_file *file,
int from_tty,
   gdb_printf (file, _("TUI source window compactness is %s.\n"), value);
 }

+bool tui_enable_mouse = true;
+
+/* Implement 'show tui mouse-events'.  */
+
+static void
+show_tui_mouse_events (struct ui_file *file, int from_tty,
+               struct cmd_list_element *c, const char *value)
+{
+  gdb_printf (file, _("TUI mouse events is %s.\n"), value);
+}
+
 /* Set the tab width of the specified window.  */
 static void
 tui_set_tab_width_command (const char *arg, int from_tty)
@@ -1284,6 +1295,19 @@ position indicator is styled."),
                &style_set_list,
                &style_show_list);

+  add_setshow_boolean_cmd ("mouse-events", class_tui,
+               &tui_enable_mouse, _("\
+Set whether TUI mode handles mouse clicks."), _("\
+Show whether TUI mode handles mouse clicks."), _("\
+When on, the TUI will interpret mouse clicks (including scroll wheel
presses),\n\
+overwriting the terminal's default behavior (usually text selection).\n\
+When off, the TUI will preserve the terminal's default behavior for mouse\n\
+events."),
+
+               NULL,
+               show_tui_mouse_events,
+               &tui_setlist, &tui_showlist);
+
   tui_border_style.changed.attach (tui_rehighlight_all, "tui-win");
   tui_active_border_style.changed.attach (tui_rehighlight_all, "tui-win");
 }
diff --git gdb/tui/tui-win.h gdb/tui/tui-win.h
index 4b33f1f2b54..039993fba34 100644
--- gdb/tui/tui-win.h
+++ gdb/tui/tui-win.h
@@ -51,6 +51,9 @@ struct cmd_list_element **tui_get_cmd_list (void);
 /* Whether compact source display should be used.  */
 extern bool compact_source;

+/* Whether the TUI should intercept terminal mouse events.  */
+extern bool tui_enable_mouse;
+
 /* Whether to style the source and assembly code highlighted by the TUI's
    current position indicator.  */
 extern bool style_tui_current_position;
-- 
2.29.2

[-- Attachment #2: 0001-gdb-tui-add-set-tui-mouse-events-off-to-restore-mous.patch --]
[-- Type: application/octet-stream, Size: 6452 bytes --]

From 991bf4f7c3d58cb8d8858cf4284c360719843350 Mon Sep 17 00:00:00 2001
From: "Matthew \"strager\" Glazar" <strager.nds@gmail.com>
Date: Fri, 27 Jan 2023 16:19:45 -0800
Subject: [PATCH] gdb/tui: add 'set tui mouse-events off' to restore mouse
 selection

Rationale:
I use the mouse with my terminal to select and copy text. In gdb, I use
the mouse to select a function name to set a breakpoint, or a variable
name to print, for example.

When gdb is compiled with ncurses mouse support, gdb's TUI mode
intercepts mouse events. Left-clicking and dragging, which would
normally select text, seems to do nothing. This means I cannot select
text using my mouse anymore. This makes it harder to set breakpoints,
print variables, etc.

Solution:
I tried to fix this issue by editing the 'mousemask' call to only enable
buttons 4 and 5. However, this still caused my terminal (gnome-terminal)
to not allow text to be selected. The only way I could make it work is
by calling 'mousemask (0, NULL);'. But doing so disables the mouse code
entirely, which other people might want.

I therefore decided to make a setting in gdb called 'tui mouse-events'.
If enabled (the default), the behavior is as it is now: terminal mouse
events are given to gdb, disabling the terminal's default behavior.
If disabled (opt-in), the behavior is as it was before the year 2020:
terminal mouse events are not given to gdb, therefore the mouse can be
used to select and copy text.

Notes:
I am not attached to the setting name or its description. Feel free to
suggest better wording.

Testing:
I tested this change in gnome-terminal by performing the following steps
manually:

1. Run: gdb --args ./myprogram
2. Enable TUI: press ctrl-x ctrl-a
3. Click and drag text with the mouse. Observe no selection.
4. Input: set tui mouse-events off
5. Click and drag text with the mouse. Observe that selection works now.
6. Input: set tui mouse-events on
7. Click and drag text with the mouse Observe no selection.
---
 gdb/NEWS            |  7 +++++++
 gdb/doc/gdb.texinfo | 13 +++++++++++++
 gdb/tui/tui-io.c    |  3 ++-
 gdb/tui/tui-win.c   | 24 ++++++++++++++++++++++++
 gdb/tui/tui-win.h   |  3 +++
 5 files changed, 49 insertions(+), 1 deletion(-)

diff --git gdb/NEWS gdb/NEWS
index 2bc1672632a..c14158e41b5 100644
--- gdb/NEWS
+++ gdb/NEWS
@@ -17,6 +17,13 @@ maintenance print record-instruction [ N ]
   prints how GDB would undo the N-th previous instruction, and if N is
   positive, it prints how GDB will redo the N-th following instruction.
 
+set tui mouse-events [on|off]
+show tui mouse-events
+  When on (default), the TUI will interpret mouse clicks (including scroll wheel
+  presses), overwriting the terminal's default behavior (usually text
+  selection). When off, the TUI will preserve the terminal's default behavior
+  for mouse events.
+
 * MI changes
 
 ** mi now reports 'no-history' as a stop reason when hitting the end of the
diff --git gdb/doc/gdb.texinfo gdb/doc/gdb.texinfo
index b5fad2cb16e..c36c24273d3 100644
--- gdb/doc/gdb.texinfo
+++ gdb/doc/gdb.texinfo
@@ -29867,6 +29867,19 @@ source text at the next tab stop; the compact display uses only as
 much space as is needed for the line numbers in the current file, and
 only a single space to separate the line numbers from the source.
 
+@item set tui mouse-events @r{[}on@r{|}off@r{]}
+@kindex set tui mouse-events
+When on (default), the TUI will interpret mouse clicks (including scroll wheel
+presses), overwriting the terminal's default behavior (usually text selection).
+When off, the TUI will preserve the terminal's default behavior for mouse
+events.
+
+Set whether the TUI source window is displayed in ``compact'' form.
+The default display uses more space for line numbers and starts the
+source text at the next tab stop; the compact display uses only as
+much space as is needed for the line numbers in the current file, and
+only a single space to separate the line numbers from the source.
+
 @kindex set debug tui
 @item set debug tui @r{[}on|off@r{]}
 Turn on or off display of @value{GDBN} internal debug messages relating
diff --git gdb/tui/tui-io.c gdb/tui/tui-io.c
index a17cf38a1f2..45ef34aeab5 100644
--- gdb/tui/tui-io.c
+++ gdb/tui/tui-io.c
@@ -655,7 +655,8 @@ static void
 tui_prep_terminal (int notused1)
 {
 #ifdef NCURSES_MOUSE_VERSION
-  mousemask (ALL_MOUSE_EVENTS, NULL);
+  if (tui_enable_mouse)
+    mousemask (ALL_MOUSE_EVENTS, NULL);
 #endif
 }
 
diff --git gdb/tui/tui-win.c gdb/tui/tui-win.c
index 008189eb99b..5709bfcbac1 100644
--- gdb/tui/tui-win.c
+++ gdb/tui/tui-win.c
@@ -897,6 +897,17 @@ tui_show_compact_source (struct ui_file *file, int from_tty,
   gdb_printf (file, _("TUI source window compactness is %s.\n"), value);
 }
 
+bool tui_enable_mouse = true;
+
+/* Implement 'show tui mouse-events'.  */
+
+static void
+show_tui_mouse_events (struct ui_file *file, int from_tty,
+		       struct cmd_list_element *c, const char *value)
+{
+  gdb_printf (file, _("TUI mouse events is %s.\n"), value);
+}
+
 /* Set the tab width of the specified window.  */
 static void
 tui_set_tab_width_command (const char *arg, int from_tty)
@@ -1284,6 +1295,19 @@ position indicator is styled."),
 			   &style_set_list,
 			   &style_show_list);
 
+  add_setshow_boolean_cmd ("mouse-events", class_tui,
+			   &tui_enable_mouse, _("\
+Set whether TUI mode handles mouse clicks."), _("\
+Show whether TUI mode handles mouse clicks."), _("\
+When on, the TUI will interpret mouse clicks (including scroll wheel presses),\n\
+overwriting the terminal's default behavior (usually text selection).\n\
+When off, the TUI will preserve the terminal's default behavior for mouse\n\
+events."),
+
+			   NULL,
+			   show_tui_mouse_events,
+			   &tui_setlist, &tui_showlist);
+
   tui_border_style.changed.attach (tui_rehighlight_all, "tui-win");
   tui_active_border_style.changed.attach (tui_rehighlight_all, "tui-win");
 }
diff --git gdb/tui/tui-win.h gdb/tui/tui-win.h
index 4b33f1f2b54..039993fba34 100644
--- gdb/tui/tui-win.h
+++ gdb/tui/tui-win.h
@@ -51,6 +51,9 @@ struct cmd_list_element **tui_get_cmd_list (void);
 /* Whether compact source display should be used.  */
 extern bool compact_source;
 
+/* Whether the TUI should intercept terminal mouse events.  */
+extern bool tui_enable_mouse;
+
 /* Whether to style the source and assembly code highlighted by the TUI's
    current position indicator.  */
 extern bool style_tui_current_position;
-- 
2.29.2


             reply	other threads:[~2023-01-28  0:43 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-01-28  0:42 strager [this message]
2023-01-28  8:35 ` Eli Zaretskii
2023-02-01  8:35   ` strager
2023-02-01 12:41     ` Eli Zaretskii
2023-02-01 13:27     ` Andrew Burgess
2023-02-02  1:08       ` strager
2023-02-02  7:18         ` Eli Zaretskii
2023-02-02 19:50         ` Pedro Alves
2023-02-02 19:59           ` strager
2023-09-14  8:05             ` strager
2023-09-20 15:39               ` Pedro Alves
2023-02-02  9:33 ` Lancelot SIX
2023-02-02 11:11   ` strager

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to='CAC-ggsEszq2WX7eZ_UdvgaBtM1YdnBFyJstr4Z0=BNW6VcMEEQ@mail.gmail.com' \
    --to=strager.nds@gmail.com \
    --cc=gdb-patches@sourceware.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).