[gdb/testsuite] Add gdb.tui/wrap-line.exp

Add a test-case that tests prompt edit wrapping behaviour in the tuiterm, both
for CLI and TUI, both with auto-detected and hard-coded width.

In the CLI case with auto-detected width we run into PR cli/30411, so add a
KFAIL for that failure mode.

Tested on x86_64-linux.

2 files changed, 188 insertions, 14 deletions

diff --git a/gdb/testsuite/gdb.tui/wrap-line.exp b/gdb/testsuite/gdb.tui/wrap-line.exp
new file mode 100644
index 0000000..b281708
--- /dev/null
+++ b/gdb/testsuite/gdb.tui/wrap-line.exp
@@ -0,0 +1,163 @@
+# Copyright 2023 Free Software Foundation, Inc.
+
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# Test prompt edit wrapping in tuiterm, both in CLI and TUI mode.
+
+# Required for tuiterm.
+require {!is_remote host}
+
+tuiterm_env
+
+# Make cols wide enough for the longest command.
+set cols 50
+set lines 24
+set dims [list $lines $cols]
+
+# Fill line, assuming we start after the gdb prompt.
+proc fill_line { width } {
+    set res ""
+
+    # Take into account that the prompt also takes space.
+    set prefix [string length "(gdb) "]
+    set start [expr $prefix + 1]
+
+    # Print chars.
+    for { set i $start } { $i <= $width } { incr i } {
+	set c [expr $i % 10]
+	send_gdb $c
+	append res $c
+    }
+
+    return $res
+}
+
+# Test wrapping.
+proc test_wrap { wrap_width } {
+    # Generate a prompt and parse it.
+    send_gdb "\003"
+    gdb_assert { [Term::wait_for "(^|$::gdb_prompt )Quit"] } "start line"
+
+    # Fill the line to just before wrapping.
+    set str [fill_line $wrap_width]
+
+    # Remaining space on line.
+    set space [string repeat " " [expr $::cols - $wrap_width]]
+
+    # Now print the first char we expect to wrap.
+    send_gdb "W"
+
+    # Check that the wrap occurred at the expected location.
+    gdb_assert { [Term::wait_for_region_contents 0 0 $::cols $::lines \
+		      "$::gdb_prompt $str$space\r\nW"] } "wrap"
+
+    # Generate a prompt and parse it.
+    send_gdb "\003"
+    gdb_assert { [Term::wait_for "^WQuit"] } "prompt after wrap"
+}
+
+# Test wrapping in both CLI and TUI.
+proc test_wrap_cli_tui { auto_detected_width } {
+    # Use a TUI layout with just a command window.
+    gdb_test_no_output "tui new-layout command-layout cmd 1"
+
+    set gdb_width 0
+    set readline_width 0
+    set re1 "Number of characters gdb thinks are in a line is ($::decimal)\\."
+    set re2 \
+	"Number of characters readline reports are in a line is ($::decimal)\\."
+    set cmd "maint info screen"
+    set re \
+	[multi_line \
+	     "^$cmd" \
+	     $re1 \
+	     $re2 \
+	    ".*"]
+    gdb_test_multiple $cmd "" {
+	-re -wrap $re {
+	    set gdb_width $expect_out(1,string)
+	    set readline_width $expect_out(2,string)
+	    pass $gdb_test_name
+	}
+    }
+
+    if { $auto_detected_width } {
+	if { $gdb_width == [expr $::cols - 1] || $gdb_width == $::cols } {
+	    # Generate KFAIL or KPASS.
+	    setup_kfail "cli/30346" "*-*-*"
+	}
+    }
+    gdb_assert { $gdb_width == $::cols } "width"
+
+    # TERM=ansi, so readline hides the last column.
+    gdb_assert { $gdb_width == [expr $readline_width + 1] }
+
+    with_test_prefix cli {
+	set wrap_width $readline_width
+
+	test_wrap $wrap_width
+    }
+
+    with_test_prefix tui {
+	if {![Term::prepare_for_tui]} {
+	    unsupported "TUI not supported"
+	    return
+	}
+
+	# Enter TUI.
+	send_gdb "layout command-layout\n"
+	gdb_assert { [Term::wait_for ""] } "switched to TUI"
+
+	# TUI interacts with readline for prompt editing, but doesn't wrap at
+	# $cols - 1.  This is due to the fact that TUI defines its own
+	# rl_redisplay_function, tui_redisplay_readline which takes its cue
+	# for wrapping from curses.
+	set wrap_width $::cols
+
+	test_wrap $wrap_width
+    }
+}
+
+with_test_prefix width-hard-coded {
+    Term::clean_restart {*}$dims
+
+    gdb_test_no_output "set width $cols"
+
+    # Run tests with hard-coded screen width.
+    test_wrap_cli_tui 0
+}
+
+with_test_prefix width-auto-detected {
+    Term::with_tuiterm {*}$dims {
+	save_vars { ::INTERNAL_GDBFLAGS } {
+	    # Avoid "set width 0" argument.
+	    set INTERNAL_GDBFLAGS \
+		[string map {{-iex "set width 0"} ""} $INTERNAL_GDBFLAGS]
+
+	    # Avoid "set width 0" in default_gdb_start.
+	    gdb_exit
+	    gdb_spawn
+	}
+
+	set test "startup prompt"
+	gdb_test_multiple "" $test {
+	    -re "^$gdb_prompt $" {
+		pass "$test"
+	    }
+	}
+    }
+
+    # Run tests with auto-detected screen width.
+    test_wrap_cli_tui 1
+}
diff --git a/gdb/testsuite/lib/tuiterm.exp b/gdb/testsuite/lib/tuiterm.exp
index 8f78c32..5e4235d 100644
--- a/gdb/testsuite/lib/tuiterm.exp
+++ b/gdb/testsuite/lib/tuiterm.exp
@@ -788,26 +788,37 @@ namespace eval Term {
 	return 1
     }
 
-    # Like ::clean_restart, but ensures that gdb starts in an
-    # environment where the TUI can work.  ROWS and COLS are the size
-    # of the terminal.  EXECUTABLE, if given, is passed to
-    # clean_restart.
-    proc clean_restart {rows cols {executable {}}} {
+    # Setup the terminal with dimensions ROWSxCOLS, TERM=ansi, and execute
+    # BODY.
+    proc with_tuiterm {rows cols body} {
 	global env stty_init
-	save_vars {env(TERM) stty_init ::GDBFLAGS} {
+	save_vars {env(TERM) stty_init} {
 	    setenv TERM ansi
 	    _setup $rows $cols
 
-	    # Make GDB not print the directory names.  Use this setting to
-	    # remove the differences in test runs due to varying directory
-	    # names.
-	    append ::GDBFLAGS " -ex \"set filename-display basename\""
+	    uplevel $body
+	}
+    }
 
-	    if {$executable == ""} {
-		::clean_restart
-	    } else {
-		::clean_restart $executable
+    # Like ::clean_restart, but ensures that gdb starts in an
+    # environment where the TUI can work.  ROWS and COLS are the size
+    # of the terminal.  EXECUTABLE, if given, is passed to
+    # clean_restart.
+    proc clean_restart {rows cols {executable {}}} {
+	with_tuiterm $rows $cols {
+	    save_vars { ::GDBFLAGS } {
+		# Make GDB not print the directory names.  Use this setting to
+		# remove the differences in test runs due to varying directory
+		# names.
+		append ::GDBFLAGS " -ex \"set filename-display basename\""
+
+		if {$executable == ""} {
+		    ::clean_restart
+		} else {
+		    ::clean_restart $executable
+		}
 	    }
+
 	    ::gdb_test_no_output "set pagination off"
 	}
     }