[binutils-gdb] [gdb/tui] Factor out require_tui_terminal

Tom de Vries via Gdb-cvs <[email protected]> Wed, 20 May 2026 06:31:17 +0000 (GMT)
Newsgroups gmane.comp.gdb.cvs
Message-ID <[email protected]>
https://sourceware.org/git/gitweb.cgi?p=binutils-gdb.git;h=faf6af4a41e7a321ee11b8e6936ea0ab84de6ca9

commit faf6af4a41e7a321ee11b8e6936ea0ab84de6ca9
Author: Tom de Vries <[email protected]>
Date:   Wed May 20 08:31:12 2026 +0200

    [gdb/tui] Factor out require_tui_terminal
    
    I noticed this bit of code in tui_enable:
    ...
          /* Check required terminal capabilities.  The MinGW port of
             ncurses does have them, but doesn't expose them through "cup".  */
          cap = tigetstr ((char *) "cup");
          if (cap == NULL || cap == (char *) -1 || *cap == '\0')
            {
              endwin ();
              delscreen (s);
              error (_("Cannot enable the TUI: "
                       "terminal doesn't support cursor addressing [TERM=%s]"),
                     gdb_getenv_term ());
            }
    ...
    
    At this point in tui_enable, we need endwin and delscreen to clean up after
    newterm, but the check can be done before newterm.
    
    Fix this by factoring out a new function require_tui_terminal, and moving the
    code there.
    
    Approved-By: Tom Tromey <[email protected]>

Diff:
---
 gdb/tui/tui.c | 45 ++++++++++++++++++++++++---------------------
 1 file changed, 24 insertions(+), 21 deletions(-)

diff --git a/gdb/tui/tui.c b/gdb/tui/tui.c
index de2faa36af7..c1457e148a2 100644
--- a/gdb/tui/tui.c
+++ b/gdb/tui/tui.c
@@ -406,6 +406,28 @@ require_tui_interpreter ()
 	   interp);
 }
 
+/* Error out if the terminal doesn't support TUI.  */
+
+static void
+require_tui_terminal ()
+{
+  /* Don't try to setup curses (and print funny control
+     characters) if we're not outputting to a terminal.  */
+  if (!gdb_stderr->isatty ())
+    error (_("Cannot enable the TUI when output is not a terminal"));
+
+  /* Check required terminal capabilities.  The MinGW port of
+     ncurses does have them, but doesn't expose them through "cup".  */
+#ifndef __MINGW32__
+  const char *cap = tigetstr ((char *) "cup");
+  const char *not_a_string_capability = (char *) -1;
+  if (cap == nullptr || cap == not_a_string_capability || *cap == '\0')
+    error (_("Cannot enable the TUI: "
+	     "terminal doesn't support cursor addressing [TERM=%s]"),
+	   gdb_getenv_term ());
+#endif
+}
+
 /* Enter in the tui mode (curses).
    When in normal mode, it installs the tui hooks in gdb, redirects
    the gdb output, configures the readline to work in tui mode.
@@ -434,18 +456,13 @@ tui_enable (void)
     {
       WINDOW *w;
       SCREEN *s;
-#ifndef __MINGW32__
-       const char *cap;
-#endif
 
       /* If the top level interpreter is not the console/tui (e.g.,
 	 MI), enabling curses will certainly lose.  */
       require_tui_interpreter ();
 
-      /* Don't try to setup curses (and print funny control
-	 characters) if we're not outputting to a terminal.  */
-      if (!gdb_stderr->isatty ())
-	error (_("Cannot enable the TUI when output is not a terminal"));
+      /* Require a terminal that supports TUI.  */
+      require_tui_terminal ();
 
       /* Don't try initialization again.  */
       tui_finish_init = TRIBOOL_UNKNOWN;
@@ -473,20 +490,6 @@ tui_enable (void)
 	  start_color ();
 	}
 
-      /* Check required terminal capabilities.  The MinGW port of
-	 ncurses does have them, but doesn't expose them through "cup".  */
-#ifndef __MINGW32__
-      cap = tigetstr ((char *) "cup");
-      if (cap == NULL || cap == (char *) -1 || *cap == '\0')
-	{
-	  endwin ();
-	  delscreen (s);
-	  error (_("Cannot enable the TUI: "
-		   "terminal doesn't support cursor addressing [TERM=%s]"),
-		 gdb_getenv_term ());
-	}
-#endif
-
       /* We must mark the tui sub-system active before trying to setup the
 	 current layout as tui windows defined by an extension language
 	 rely on this flag being true in order to know that the window