Re: [PATCH 03/22] Forward mouse click to python TUI window

[Andrew Burgess <andrew.burgess@embecosm.com>]

* Hannes Domani via Gdb-patches <gdb-patches@sourceware.org> [2021-03-06 18:33:58 +0100]:

> If the TUI window object implements the click method, it is called for each
> mouse click event in this window.
> ---
>  gdb/doc/python.texi |  6 ++++++
>  gdb/python/py-tui.c | 17 +++++++++++++++++
>  2 files changed, 23 insertions(+)
> 
> diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
> index ba3d2f92a43..97a28d054fa 100644
> --- a/gdb/doc/python.texi
> +++ b/gdb/doc/python.texi
> @@ -5925,6 +5925,12 @@ 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, and @var{button} specifies which
> +mouse button was used.
> +@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 72e9c0d5e2b..39753aed468 100644
> --- a/gdb/python/py-tui.c
> +++ b/gdb/python/py-tui.c
> @@ -99,6 +99,8 @@ class tui_py_window : public tui_win_info
>        }
>    }
>  
> +  void click (int mouse_x, int mouse_y, int mouse_button) override;
> +

Unfortunately py-tui.c is pretty hit & miss w.r.t. comments, but this
function really should be commented.

>    /* Erase and re-box the window.  */
>    void erase ()
>    {
> @@ -226,6 +228,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)
> +{

And this should have a comment that redirects to the class
declaration.


Thanks,
Andrew

> +  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)
>  {
> -- 
> 2.30.1
>