[PATCH 1/2] gdb: make get_chars_per_line return an unsigned value

[Andrew Burgess <aburgess@redhat.com>]

I noticed that get_chars_per_line currently returns an 'int', but the
value it is returning, from utils.c, is an 'unsigned int'.  In some
cases this can cause weird behaviour as an unlimited width terminal
will have UINT_MAX characters per line, which will appear as negative
when returned from get_chars_per_line.

This has been the case since get_chars_per_line was added in commit:

  commit 2f2287318b33ddf855a692fcc191f6b25caf4644
  Date:   Wed Dec 16 18:18:40 2020 +0100

      [gdb/cli] Add a progress meter

Lets make get_chars_per_line return an unsigned value, and update all
the uses of this function to hold the result in an unsigned variable.

I ran into this issue when looking at print_gdb_hints (from top.c)
where a very large get_chars_per_line() value would appear negative,
and so the startup hints would be printed without a box when really
they should have been boxed.  Someone else noticed this problem while
I was building this patch, and pushed commit:

  commit 06e470d8fc0ae0e83fe0977fdf8c011998980891
  Date:   Sat Nov 29 15:48:55 2025 +0100

      gdb: handle unlimited screen width case in print_gdb_hints

this commit reverts that earlier commit in favour of fixing the type
of 'width'.  There are other bugs in this code relating to how 'width'
is handled, but they are fixed in the next commit.

Additionally, in cli-out.c I've had to add some additional code so
that the progress bars are disabled when the screen width is
unlimited.

Previously, an unlimited screen width would appear as a negative
value, which was less than MIN_CHARS_PER_LINE, so the progress bars
would be disabled.  Our existing debuginfod tests rely on this.

To minimise disruption to the tests, for now, I've updated the code in
cli-out.c so that we specifically disable progress bars when the
screen width is unlimited, as it is during our tests.

It would be better, in the future, if we had a separate setting to
disable progress bars, and the testsuite could use this.

There's no tests with this commit yet as print_gdb_hints has other
bugs which will be fixed in the next commit.  At this point I'll add
some tests.

Reviewed-By: Guinevere Larsen <guinevere@redhat.com>
---
 gdb/cli-out.c | 10 ++++++----
 gdb/top.c     | 10 +++++-----
 gdb/utils.c   |  3 ++-
 gdb/utils.h   |  5 +++--
 4 files changed, 16 insertions(+), 12 deletions(-)

diff --git a/gdb/cli-out.c b/gdb/cli-out.c
index 27a82f607eb..137ff13ef5d 100644
--- a/gdb/cli-out.c
+++ b/gdb/cli-out.c
@@ -298,7 +298,7 @@ cli_ui_out::do_progress_notify (const std::string &msg,
 				const char *unit,
 				double howmuch, double total)
 {
-  int chars_per_line = get_chars_per_line ();
+  unsigned int chars_per_line = get_chars_per_line ();
   struct ui_file *stream = get_unbuffered (m_streams.back ());
   cli_progress_info &info (m_progress_info.back ());
 
@@ -322,7 +322,8 @@ cli_ui_out::do_progress_notify (const std::string &msg,
     }
 
   if (info.state != progress_update::BAR
-      || chars_per_line < MIN_CHARS_PER_LINE)
+      || chars_per_line < MIN_CHARS_PER_LINE
+      || chars_per_line == UINT_MAX)
     return;
 
   if (total > 0 && howmuch >= 0 && howmuch <= 1.0)
@@ -385,14 +386,15 @@ void
 cli_ui_out::clear_progress_notify ()
 {
   struct ui_file *stream = get_unbuffered (m_streams.back ());
-  int chars_per_line = get_chars_per_line ();
+  unsigned int chars_per_line = get_chars_per_line ();
 
   scoped_restore save_pagination
     = make_scoped_restore (&pagination_enabled, false);
 
   if (!stream->isatty ()
       || !current_ui->input_interactive_p ()
-      || chars_per_line < MIN_CHARS_PER_LINE)
+      || chars_per_line < MIN_CHARS_PER_LINE
+      || chars_per_line == UINT_MAX)
     return;
 
   if (chars_per_line > MAX_CHARS_PER_LINE)
diff --git a/gdb/top.c b/gdb/top.c
index 1214101ad18..1aefe74b394 100644
--- a/gdb/top.c
+++ b/gdb/top.c
@@ -1414,7 +1414,7 @@ box_one_message (ui_file *stream, std::string message, int width)
 void
 print_gdb_hints (struct ui_file *stream)
 {
-  int width = get_chars_per_line ();
+  unsigned int width = get_chars_per_line ();
 
   /* Arbitrarily setting maximum width to 80 characters, so that
      things are big and visible but not overwhelming.  */
@@ -1439,10 +1439,10 @@ print_gdb_hints (struct ui_file *stream)
 	      styled_string (command_style.style (), "apropos <word>"));
 
   /* If there isn't enough space to display the longest URL in a boxed
-     style or if screen width is unlimited, use the simple styling of a
-     singular visual break.  The longest URL is used because the other
-     messages may be broken into multiple lines, but URLs can't.  */
-  if (width - 3 <= (int) docs_url.length ())
+     style, use the simple styling of a singular visual break.  The longest
+     URL is used because the other messages may be broken into multiple
+     lines, but URLs can't.  */
+  if (width - 3 <= docs_url.length ())
     {
       for (string_file &msg : styled_msg)
 	gdb_printf (stream, "%s\n", msg.c_str ());
diff --git a/gdb/utils.c b/gdb/utils.c
index ffe0d639e3a..d322843925b 100644
--- a/gdb/utils.c
+++ b/gdb/utils.c
@@ -1548,9 +1548,10 @@ gdb_flush (struct ui_file *stream)
 
 /* See utils.h.  */
 
-int
+unsigned int
 get_chars_per_line ()
 {
+  gdb_assert (chars_per_line > 0);
   return chars_per_line;
 }
 
diff --git a/gdb/utils.h b/gdb/utils.h
index 0e28f9424e5..6316547653e 100644
--- a/gdb/utils.h
+++ b/gdb/utils.h
@@ -157,9 +157,10 @@ extern void wrap_here (int);
 
 extern void reinitialize_more_filter (void);
 
-/* Return the number of characters in a line.  */
+/* Return the number of characters in a line.  Will never be zero, but can
+   be UINT_MAX, which indicates unlimited characters per line.  */
 
-extern int get_chars_per_line ();
+extern unsigned int get_chars_per_line ();
 
 extern bool pagination_enabled;
 
-- 
2.47.1