[Bug python/32162] New: Add visible/hidden callbacks to Python TUI windows

[Bug python/32162] New: Add visible/hidden callbacks to Python TUI windows

[peacemakerctf at gmail dot com]

https://sourceware.org/bugzilla/show_bug.cgi?id=32162

            Bug ID: 32162
           Summary: Add visible/hidden callbacks to Python TUI windows
           Product: gdb
           Version: HEAD
            Status: UNCONFIRMED
          Severity: normal
          Priority: P2
         Component: python
          Assignee: unassigned at sourceware dot org
          Reporter: peacemakerctf at gmail dot com
  Target Milestone: ---

A Python TuiWindow does not have a callback to react to the TUI mode getting
enabled or disabled. This would be useful to allow to change settings when the
window is actually displayed and reset them when switching to CLI mode. Right
now the lifecycle of a TuiWindow isn't fully covered by events and you have to
check `self.is_valid()` every time to see if the window is currently displayed
or not.

This could be implemented by adding a `hidden` and `visible` function to the
Window protocol which would be called when tui mode is disabled/enabled.

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug python/32162] Add visible/hidden callbacks to Python TUI windows

[tromey at sourceware dot org]

https://sourceware.org/bugzilla/show_bug.cgi?id=32162

Tom Tromey <tromey at sourceware dot org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |tromey at sourceware dot org

--- Comment #1 from Tom Tromey <tromey at sourceware dot org> ---
The way the lifetime is intended to work is based on the object
supplied by the callback function you register.

This callback function is called when your TUI window is instantiated.
This is essentially the "visible" function -- when this is called
by gdb, it means the window will be shown.

The callback function returns an object conforming to a certain
protocol.  One of the possible methods on this object is the
"close" method.  When this is called by gdb, it means the window
is being hidden.

gdb doesn't really distinguish between the reasons that a TUI
window might be hidden or shown.  Like, switching layouts
or exiting the TUI both just result in window destruction.

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug python/32162] Add visible/hidden callbacks to Python TUI windows

[tromey at sourceware dot org]

https://sourceware.org/bugzilla/show_bug.cgi?id=32162

--- Comment #2 from Tom Tromey <tromey at sourceware dot org> ---
Forgot to say -- I tend to think this is already implemented,
and so I'd like to close it.  However I wanted to check in
with you first.  Thanks.

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug python/32162] Add visible/hidden callbacks to Python TUI windows

[ssbssa at sourceware dot org]

https://sourceware.org/bugzilla/show_bug.cgi?id=32162

Hannes Domani <ssbssa at sourceware dot org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |ssbssa at sourceware dot org

--- Comment #3 from Hannes Domani <ssbssa at sourceware dot org> ---
At what points do you update the window contents?

In my windows I use the before_prompt event to do that, plus checking
is_valid() as you said.
Like this I always know if my window is visible or not.

And I wonder why you want to reset some settings when switching to CLI, because
I would expect that the TUI window contents stay the same when I switch back.

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug python/32162] Add visible/hidden callbacks to Python TUI windows

[ssbssa at sourceware dot org]

https://sourceware.org/bugzilla/show_bug.cgi?id=32162

--- Comment #4 from Hannes Domani <ssbssa at sourceware dot org> ---
(In reply to Tom Tromey from comment #1)
> gdb doesn't really distinguish between the reasons that a TUI
> window might be hidden or shown.  Like, switching layouts
> or exiting the TUI both just result in window destruction.

AFAIK that's not how it's working now.
A TUI window is only destroyed when the layout is switched, but not when
leaving TUI.

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug python/32162] Add visible/hidden callbacks to Python TUI windows

[tromey at sourceware dot org]

https://sourceware.org/bugzilla/show_bug.cgi?id=32162

--- Comment #5 from Tom Tromey <tromey at sourceware dot org> ---
(In reply to Hannes Domani from comment #4)
> (In reply to Tom Tromey from comment #1)
> > gdb doesn't really distinguish between the reasons that a TUI
> > window might be hidden or shown.  Like, switching layouts
> > or exiting the TUI both just result in window destruction.
> 
> AFAIK that's not how it's working now.
> A TUI window is only destroyed when the layout is switched, but not when
> leaving TUI.

Ok, that's actually a bit surprising then.
Maybe that's the change we should make.

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug python/32162] Add visible/hidden callbacks to Python TUI windows

[ssbssa at sourceware dot org]

https://sourceware.org/bugzilla/show_bug.cgi?id=32162

--- Comment #6 from Hannes Domani <ssbssa at sourceware dot org> ---
(In reply to Tom Tromey from comment #5)
> (In reply to Hannes Domani from comment #4)
> > (In reply to Tom Tromey from comment #1)
> > > gdb doesn't really distinguish between the reasons that a TUI
> > > window might be hidden or shown.  Like, switching layouts
> > > or exiting the TUI both just result in window destruction.
> > 
> > AFAIK that's not how it's working now.
> > A TUI window is only destroyed when the layout is switched, but not when
> > leaving TUI.
> 
> Ok, that's actually a bit surprising then.
> Maybe that's the change we should make.

Actually, I like the behavior like this.
I often switch to CLI if I expect some command to have more than a few lines of
output.
And when I switch back to TUI, everything is as I left it.

But if the windows are destroyed when leaving TUI, that's no longer possible.

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug python/32162] Add visible/hidden callbacks to Python TUI windows

[tromey at sourceware dot org]

https://sourceware.org/bugzilla/show_bug.cgi?id=32162

--- Comment #7 from Tom Tromey <tromey at sourceware dot org> ---
I suppose we could also just add a new method meaning
"TUI disabled".

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug python/32162] Add visible/hidden callbacks to Python TUI windows

[peacemakerctf at gmail dot com]

https://sourceware.org/bugzilla/show_bug.cgi?id=32162

--- Comment #8 from Jannik <peacemakerctf at gmail dot com> ---
(In reply to Tom Tromey from comment #2)
> Forgot to say -- I tend to think this is already implemented,
> and so I'd like to close it.  However I wanted to check in
> with you first.  Thanks.

As Hannes pointed out, switching layouts or exiting the TUI don't both trigger
a `close()` call. Thank you for considering this case. If `render()` is called
when the TUI is enabled again, a new method when disabling the TUI might
suffice indeed.

(In reply to Hannes Domani from comment #3)
> At what points do you update the window contents?
> 
> In my windows I use the before_prompt event to do that, plus checking
> is_valid() as you said.
> Like this I always know if my window is visible or not.
> 
> And I wonder why you want to reset some settings when switching to CLI,
> because I would expect that the TUI window contents stay the same when I
> switch back.

I'm redirecting output of custom commands to the window instead of printing
them out to the console like in CLI mode. So switching back to CLI requires
resetting this and printing the output out normally again.

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug python/32162] Add visible/hidden callbacks to Python TUI windows

[tromey at sourceware dot org]

https://sourceware.org/bugzilla/show_bug.cgi?id=32162

--- Comment #9 from Tom Tromey <tromey at sourceware dot org> ---
(In reply to Jannik from comment #8)

> As Hannes pointed out, switching layouts or exiting the TUI don't both
> trigger a `close()` call.

For me, switching layouts does call close().

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug python/32162] Add visible/hidden callbacks to Python TUI windows

[tromey at sourceware dot org]

https://sourceware.org/bugzilla/show_bug.cgi?id=32162

--- Comment #10 from Tom Tromey <tromey at sourceware dot org> ---
Test code showing the above:

import gdb


class EventWindow:
    def __init__(self, win):
        self._win = win
        win.title = "Hi Bob"
        self.render()

    def close(self):
        print("close called")

    def render(self):
        self._win.erase()
        self._win.write("Assuming your name is Bob")


gdb.register_window_type("events", EventWindow)
gdb.execute("tui new-layout zzz src 1 events 1 status 0 cmd 1")

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug python/32162] Add visible/hidden callbacks to Python TUI windows

[ssbssa at sourceware dot org]

https://sourceware.org/bugzilla/show_bug.cgi?id=32162

--- Comment #11 from Hannes Domani <ssbssa at sourceware dot org> ---
(In reply to Tom Tromey from comment #9)
> (In reply to Jannik from comment #8)
> 
> > As Hannes pointed out, switching layouts or exiting the TUI don't both
> > trigger a `close()` call.
> 
> For me, switching layouts does call close().

Yes, that's what I also wrote:

(In reply to Hannes Domani from comment #4)
> A TUI window is only destroyed when the layout is switched, but not when
> leaving TUI.

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug python/32162] Add visible/hidden callbacks to Python TUI windows

[tromey at sourceware dot org]

https://sourceware.org/bugzilla/show_bug.cgi?id=32162

Tom Tromey <tromey at sourceware dot org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|UNCONFIRMED                 |NEW
   Last reconfirmed|                            |2024-09-25
     Ever confirmed|0                           |1

--- Comment #12 from Tom Tromey <tromey at sourceware dot org> ---
I have a patch to add a new event so code can watch
for TUI enable/disable.

I didn't write tests or docs yet though so it may be a little while.

I'm not certain we should promise that "tui disable" will always
work the way it happens to work today.

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug python/32162] Add visible/hidden callbacks to Python TUI windows

[tromey at sourceware dot org]

https://sourceware.org/bugzilla/show_bug.cgi?id=32162

Tom Tromey <tromey at sourceware dot org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
           Assignee|unassigned at sourceware dot org   |tromey at sourceware dot org

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug python/32162] Add visible/hidden callbacks to Python TUI windows

[tromey at sourceware dot org]

https://sourceware.org/bugzilla/show_bug.cgi?id=32162

--- Comment #13 from Tom Tromey <tromey at sourceware dot org> ---
https://sourceware.org/pipermail/gdb-patches/2024-September/211992.html

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug python/32162] Add visible/hidden callbacks to Python TUI windows

[cvs-commit at gcc dot gnu.org]

https://sourceware.org/bugzilla/show_bug.cgi?id=32162

--- Comment #14 from Sourceware Commits <cvs-commit at gcc dot gnu.org> ---
The master branch has been updated by Tom Tromey <tromey@sourceware.org>:

https://sourceware.org/git/gitweb.cgi?p=binutils-gdb.git;h=76367d23146136b457b1494285b807437a9fec60

commit 76367d23146136b457b1494285b807437a9fec60
Author: Tom Tromey <tromey@adacore.com>
Date:   Wed Sep 25 08:27:51 2024 -0600

    Add gdb.events.tui_enabled

    This adds a new event source so that Python scripts can track whether
    or not the TUI is presently enabled.

    v2 of the patch renames "status" -> "enabled".

    Bug: https://sourceware.org/bugzilla/show_bug.cgi?id=32162
    Reviewed-By: Eli Zaretskii <eliz@gnu.org>
    Reviewed-by: Keith Seitz <keiths@redhat.com>

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug python/32162] Add visible/hidden callbacks to Python TUI windows

[tromey at sourceware dot org]

https://sourceware.org/bugzilla/show_bug.cgi?id=32162

Tom Tromey <tromey at sourceware dot org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|NEW                         |RESOLVED
         Resolution|---                         |FIXED
   Target Milestone|---                         |16.1

--- Comment #15 from Tom Tromey <tromey at sourceware dot org> ---
Fixed.

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug python/32162] Add visible/hidden callbacks to Python TUI windows

[oleg.tolmatcev at gmail dot com]

https://sourceware.org/bugzilla/show_bug.cgi?id=32162

Oleg Tolmatcev <oleg.tolmatcev at gmail dot com> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |oleg.tolmatcev at gmail dot com

--- Comment #16 from Oleg Tolmatcev <oleg.tolmatcev at gmail dot com> ---
I think you forgot to rename "TuiStatusEvent" in the documentation:

@defvar TuiStatusEvent.enabled
If the TUI has just been enabled, this is @code{True}; otherwise it is
@code{False}.
@end defvar

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug python/32162] Add visible/hidden callbacks to Python TUI windows

[cvs-commit at gcc dot gnu.org]

https://sourceware.org/bugzilla/show_bug.cgi?id=32162

--- Comment #17 from Sourceware Commits <cvs-commit at gcc dot gnu.org> ---
The master branch has been updated by Tom Tromey <tromey@sourceware.org>:

https://sourceware.org/git/gitweb.cgi?p=binutils-gdb.git;h=bf63e092606ea6c0d894a761edc8b5c127df0efe

commit bf63e092606ea6c0d894a761edc8b5c127df0efe
Author: Tom Tromey <tromey@adacore.com>
Date:   Wed Dec 18 08:34:31 2024 -0700

    Fix typo in Python documentation

    Oleg pointed out that when renaming from "status" to "enabled" in the
    Python TUI events patch, I neglected to update one spot in the
    documentation.  This patch fixes this.  I'm checking it in as obvious.

    You can verify that this change is correct by examining
    gdb/python/py-event-types.def.

    Bug: https://sourceware.org/bugzilla/show_bug.cgi?id=32162

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug python/32162] Add visible/hidden callbacks to Python TUI windows

[tromey at sourceware dot org]

https://sourceware.org/bugzilla/show_bug.cgi?id=32162

--- Comment #18 from Tom Tromey <tromey at sourceware dot org> ---
(In reply to Oleg Tolmatcev from comment #16)
> I think you forgot to rename "TuiStatusEvent" in the documentation:

Thanks.  I just fixed this.

-- 
You are receiving this mail because:
You are on the CC list for the bug.