gdb/tui: add 'set tui mouse-events off' to restore mouse selection
authorMatthew "strager" Glazar <strager.nds@gmail.com>
Sat, 28 Jan 2023 00:19:45 +0000 (16:19 -0800)
committerPedro Alves <pedro@palves.net>
Wed, 20 Sep 2023 15:35:36 +0000 (16:35 +0100)
commit0f6a69947891fc448c37e944d6c3e266621d35a8
tree24fabc6ae9aeb340b42ae5d6a9c495111d7a71a6
parent973db6fae304c2bcafff5f169610f663adc9e817
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
gdb/doc/gdb.texinfo
gdb/doc/python.texi
gdb/tui/tui-io.c
gdb/tui/tui-win.c
gdb/tui/tui-win.h