[PATCHv3,2/2] Forward mouse click to python TUI window

Message ID 20210603151453.15248-2-ssbssa@yahoo.de
State New
Headers show
Series
  • [PATCHv3,1/2] Initial TUI mouse support
Related show

Commit Message

Simon Marchi via Gdb-patches June 3, 2021, 3:14 p.m.
If the TUI window object implements the click method, it is called for each
mouse click event in this window.

gdb/ChangeLog:

2021-06-03  Hannes Domani  <ssbssa@yahoo.de>

	* python/py-tui.c (class tui_py_window): Add click function.
	(tui_py_window::click): Likewise.

gdb/doc/ChangeLog:

2021-06-03  Hannes Domani  <ssbssa@yahoo.de>

	* python.texi (TUI Windows In Python): Document Window.click.
---
v2:
- Added ChangeLog.
- Specify in the documentation that mouse coordinates are 0-based.
v3:
- Mention possible button values.
---
 gdb/doc/python.texi |  7 +++++++
 gdb/python/py-tui.c | 17 +++++++++++++++++
 2 files changed, 24 insertions(+)

-- 
2.31.1

Comments

Simon Marchi via Gdb-patches June 3, 2021, 5:16 p.m. | #1
> Date: Thu,  3 Jun 2021 17:14:53 +0200

> From: Hannes Domani via Gdb-patches <gdb-patches@sourceware.org>

> 

> If the TUI window object implements the click method, it is called for each

> mouse click event in this window.

> 

> gdb/ChangeLog:

> 

> 2021-06-03  Hannes Domani  <ssbssa@yahoo.de>

> 

> 	* python/py-tui.c (class tui_py_window): Add click function.

> 	(tui_py_window::click): Likewise.

> 

> gdb/doc/ChangeLog:

> 

> 2021-06-03  Hannes Domani  <ssbssa@yahoo.de>

> 

> 	* python.texi (TUI Windows In Python): Document Window.click.


Thanks, the documentation part is OK.
Tom Tromey June 4, 2021, 1:52 p.m. | #2
>>>>> "Hannes" == Hannes Domani via Gdb-patches <gdb-patches@sourceware.org> writes:


Hannes> If the TUI window object implements the click method, it is called for each
Hannes> mouse click event in this window.

Hannes> gdb/ChangeLog:

Hannes> 2021-06-03  Hannes Domani  <ssbssa@yahoo.de>

Hannes> 	* python/py-tui.c (class tui_py_window): Add click function.
Hannes> 	(tui_py_window::click): Likewise.

Hannes> gdb/doc/ChangeLog:

Hannes> 2021-06-03  Hannes Domani  <ssbssa@yahoo.de>

Hannes> 	* python.texi (TUI Windows In Python): Document Window.click.

Thanks for the update.  Looks good.

Tom

Patch

diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index 0d8f480e472..7574d29f2c2 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -6022,6 +6022,13 @@  contents.  A positive argument should cause the viewport to move down,
 and so the content should appear to move up.
 @end defun
 
+@defun Window.click (@var{x}, @var{y}, @var{button})
+This is called on a mouse click in this window.  @var{x} and @var{y} are
+the mouse coordinates inside the window (0-based), and @var{button}
+specifies which mouse button was used, whose values can be 1 (left),
+2 (middle), or 3 (right).
+@end defun
+
 @node Python Auto-loading
 @subsection Python Auto-loading
 @cindex Python auto-loading
diff --git a/gdb/python/py-tui.c b/gdb/python/py-tui.c
index 97e9de7a00c..8dfed9d341f 100644
--- a/gdb/python/py-tui.c
+++ b/gdb/python/py-tui.c
@@ -101,6 +101,8 @@  class tui_py_window : public tui_win_info
       tui_win_info::refresh_window ();
   }
 
+  void click (int mouse_x, int mouse_y, int mouse_button) override;
+
   /* Erase and re-box the window.  */
   void erase ()
   {
@@ -229,6 +231,21 @@  tui_py_window::do_scroll_vertical (int num_to_scroll)
     }
 }
 
+void
+tui_py_window::click (int mouse_x, int mouse_y, int mouse_button)
+{
+  gdbpy_enter enter_py (get_current_arch (), current_language);
+
+  if (PyObject_HasAttrString (m_window.get (), "click"))
+    {
+      gdbpy_ref<> result (PyObject_CallMethod (m_window.get (), "click",
+					       "iii", mouse_x, mouse_y,
+					       mouse_button));
+      if (result == nullptr)
+	gdbpy_print_stack ();
+    }
+}
+
 void
 tui_py_window::output (const char *text, bool full_window)
 {