[PATCH 2/2] gdb/tui: fix issue with handling the return character

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

My initial goal was to fix our gdb/testsuite/lib/tuiterm.exp such that
it would correctly support (some limited) scrolling of the command
window.

What I observe is that when sending commands to the tui command window
in a test script with:

  Term::command "p 1"

The command window would be left looking like this:

  (gdb)
  (gdb) p 1$1 = 1
  (gdb)

When I would have expected it to look like this:

  (gdb) p 1
  $1 = 1
  (gdb)

Obviously a bug in our tuiterm.exp library, right???

Wrong!

Turns out there's a bug in GDB.

If in GDB I enable the tui and then type (slowly) the 'p 1\r' (the \r
is pressing the return key at the end of the string), then you do
indeed get the "expected" terminal output.

However, if instead I copy the 'p 1\r' string and paste it into the
tui in one go then I now see the same corrupted output as we do when
using tuiterm.exp.

It turns out the problem is that GDB fails when handling lots of input
arriving quickly with a \r (or \n) on the end.

The reason for this bug is as follows:

When the tui is active the terminal is in no-echo mode, so characters
sent to the terminal are not echoed out again.  This means that when
the user types \r, this is not echoed to the terminal.

The characters read in are passed to readline and \r indicates that
the command line is complete and ready to be processed.  However, the
\r is not included in readlines command buffer, and is NOT printed by
readline when is displays its buffer to the screen.

So, in GDB we have to manually spot the \r when it is read in and
update the display.  Printing a newline character to the output and
moving the cursor to the next line.  This is done in tui_getc_1.

Now readline tries to reduce the number of write calls.  So if we very
quickly (as in paste in one go) the text 'p 1' to readline (this time
with no \r on the end), then readline will fetch the fist character
and add it to its internal buffer.  But before printing the character
out readline checks to see if there's more input incoming.  As we
pasted multiple characters, then yes, readline sees the ' ' and adds
this to its buffer, and finally the '1', this too is added to the
buffer.

Now if at this point we take a break, readline sees there is no more
input available, and so prints its buffer out.

Now when we press \r the code in tui_getc_1 kicks in, adds a \n to the
output and moves the cursor to the next line.

But, if instead we paste 'p 1\r' in one go then readline adds 'p 1' to
its buffer as before, but now it sees that there is still more input
available.  Now it fetches the '\r', but this triggers the newline
behaviour, we print '\n' and move to the next line - however readline
has not printed its buffer yet!

So finally we end up on the next line.  There's no more input
available so readline prints its buffer, then GDB gets passed the
buffer, handles it, and prints the result.

The solution I think is to put of our special newline insertion code
until we know that readline has finished printing its buffer.  Handily
we know when this is - the next thing readline does is pass us the
command line buffer for processing.  So all we need to do is hook in
to the command line processing, and before we pass the command line to
GDB's internals we do all of the magic print a newline and move the
cursor to the next line stuff.

Luckily, GDB's interpreter mechanism already provides the hooks we
need to do this.  So all I do here is move the newline printing code
from tui_getc_1 into a new function, setup a new input_handler hook
for the tui, and call my new newline printing function.

After this I can enable the tui and paste in 'p 1\r' and see the
correct output.

Also the tuiterm.exp library will now see non-corrupted output.

gdb/ChangeLog:

	* tui/tui-interp.c (tui_command_line_handler): New function.
	(tui_interp::resume): Register tui_command_line_handler as the
	input_handler.
	* tui/tui-io.c (tui_inject_newline_into_command_window): New
	function.
	(tui_getc_1): Delete handling of '\n' and '\r'.
	* tui-io.h (tui_inject_newline_into_command_window): Declare.

gdb/testsuite/ChangeLog:

	* gdb.tui/scroll.exp: Tighten expected results.  Remove comment
	about bug in GDB.
---
 gdb/ChangeLog                    | 10 +++++
 gdb/testsuite/ChangeLog          |  5 +++
 gdb/testsuite/gdb.tui/scroll.exp | 28 ++++--------
 gdb/tui/tui-interp.c             | 23 +++++++++-
 gdb/tui/tui-io.c                 | 73 +++++++++++++++++---------------
 gdb/tui/tui-io.h                 |  5 +++
 6 files changed, 90 insertions(+), 54 deletions(-)

diff --git a/gdb/testsuite/gdb.tui/scroll.exp b/gdb/testsuite/gdb.tui/scroll.exp
index 4566bd8f5c7..f71d052da16 100644
--- a/gdb/testsuite/gdb.tui/scroll.exp
+++ b/gdb/testsuite/gdb.tui/scroll.exp
@@ -38,25 +38,15 @@ for {set i 0} {$i < 10} {incr i 1} {
 }
 
 # Now check that the contents of the command window are as expected.
-#
-# Well, we would if there wasn't a massive bug in GDB!!  The command
-# window contents will not be exactly what you'd expect after this
-# test has run.
-#
-# The expected output pattern given here is crafted so that it matches
-# those bits of the GDB output that will be correct, and ignores those
-# parts of the output that are known to be incorrect.
-#
-# If/when GDB is fixed it is expected that this test will continue to
-# pass, though it is possible that at that point the pattern here
-# could be improved.
 Term::check_region_contents "check cmd window" 0 16 80 8 \
     [multi_line \
-	 "\[^\r\n\]*\\\$7 = 6\[^\r\n\]+" \
-	 "\\(gdb\\)\[^\r\n\]+" \
-	 "\[^\r\n\]*\\\$8 = 7\[^\r\n\]+" \
-	 "\\(gdb\\)\[^\r\n\]+" \
-	 "\[^\r\n\]*\\\$9 = 8\[^\r\n\]+" \
-	 "\\(gdb\\)\[^\r\n\]+" \
-	 "\[^\r\n\]*\\\$10 = 9\[^\r\n\]+" \
+	 "\\\$7 = 6\\s+" \
+	 "\\(gdb\\) p 7\\s+" \
+	 "\\\$8 = 7\\s+" \
+	 "\\(gdb\\) p 8\\s+" \
+	 "\\\$9 = 8\\s+" \
+	 "\\(gdb\\) p 9\\s+" \
+	 "\\\$10 = 9\\s+" \
 	 "\\(gdb\\)"]
+
+Term::dump_screen
diff --git a/gdb/tui/tui-interp.c b/gdb/tui/tui-interp.c
index 331e97ff11f..f70e1a7b4c2 100644
--- a/gdb/tui/tui-interp.c
+++ b/gdb/tui/tui-interp.c
@@ -247,6 +247,27 @@ tui_interp::init (bool top_level)
     tui_ensure_readline_initialized ();
 }
 
+/* Used as the command handler for the tui.  */
+
+static void
+tui_command_line_handler (gdb::unique_xmalloc_ptr<char> &&rl)
+{
+  /* When a tui enabled GDB is running in either tui mode or cli mode then
+     it is always the tui interpreter that is in use.  As a result we end
+     up in here even in standard cli mode.
+
+     We only need to do any special actions when the tui is in use
+     though.  When the tui is active the users return is not echoed to the
+     screen as a result the display will not automatically move us to the
+     next line.  Here we manually insert a newline character and move the
+     cursor.  */
+  if (tui_active)
+    tui_inject_newline_into_command_window ();
+
+  /* Now perform GDB's standard CLI command line handling.  */
+  command_line_handler (std::move (rl));
+}
+
 void
 tui_interp::resume ()
 {
@@ -266,7 +287,7 @@ tui_interp::resume ()
 
   gdb_setup_readline (1);
 
-  ui->input_handler = command_line_handler;
+  ui->input_handler = tui_command_line_handler;
 
   if (stream != NULL)
     tui_old_uiout->set_stream (gdb_stdout);
diff --git a/gdb/tui/tui-io.c b/gdb/tui/tui-io.c
index 0a33d53e869..a2be4d4353e 100644
--- a/gdb/tui/tui-io.c
+++ b/gdb/tui/tui-io.c
@@ -991,6 +991,45 @@ tui_dispatch_ctrl_char (unsigned int ch)
   return 0;
 }
 
+/* See tui-io.h.   */
+
+void
+tui_inject_newline_into_command_window ()
+{
+  gdb_assert (tui_active);
+
+  WINDOW *w= TUI_CMD_WIN->handle.get ();
+
+  /* When hitting return with an empty input, gdb executes the last
+     command.  If we emit a newline, this fills up the command window
+     with empty lines with gdb prompt at beginning.  Instead of that,
+     stay on the same line but provide a visual effect to show the
+     user we recognized the command.  */
+  if (rl_end == 0 && !gdb_in_secondary_prompt_p (current_ui))
+    {
+      wmove (w, getcury (w), 0);
+
+      /* Clear the line.  This will blink the gdb prompt since
+	 it will be redrawn at the same line.  */
+      wclrtoeol (w);
+      wrefresh (w);
+      napms (20);
+    }
+  else
+    {
+      /* Move cursor to the end of the command line before emitting the
+	 newline.  We need to do so because when ncurses outputs a newline
+	 it truncates any text that appears past the end of the cursor.  */
+      int px, py;
+      getyx (w, py, px);
+      px += rl_end - rl_point;
+      py += px / TUI_CMD_WIN->width;
+      px %= TUI_CMD_WIN->width;
+      wmove (w, py, px);
+      tui_putc ('\n');
+    }
+}
+
 /* Main worker for tui_getc.  Get a character from the command window.
    This is called from the readline package, but wrapped in a
    try/catch by tui_getc.  */
@@ -1010,40 +1049,6 @@ tui_getc_1 (FILE *fp)
 
   ch = gdb_wgetch (w);
 
-  /* The \n must be echoed because it will not be printed by
-     readline.  */
-  if (ch == '\n' || ch == '\r')
-    {
-      /* When hitting return with an empty input, gdb executes the last
-	 command.  If we emit a newline, this fills up the command window
-	 with empty lines with gdb prompt at beginning.  Instead of that,
-	 stay on the same line but provide a visual effect to show the
-	 user we recognized the command.  */
-      if (rl_end == 0 && !gdb_in_secondary_prompt_p (current_ui))
-	{
-	  wmove (w, getcury (w), 0);
-
-	  /* Clear the line.  This will blink the gdb prompt since
-	     it will be redrawn at the same line.  */
-	  wclrtoeol (w);
-	  wrefresh (w);
-	  napms (20);
-	}
-      else
-	{
-	  /* Move cursor to the end of the command line before emitting the
-	     newline.  We need to do so because when ncurses outputs a newline
-	     it truncates any text that appears past the end of the cursor.  */
-	  int px, py;
-	  getyx (w, py, px);
-	  px += rl_end - rl_point;
-	  py += px / TUI_CMD_WIN->width;
-	  px %= TUI_CMD_WIN->width;
-	  wmove (w, py, px);
-	  tui_putc ('\n');
-	}
-    }
-  
   /* Handle prev/next/up/down here.  */
   ch = tui_dispatch_ctrl_char (ch);
   
diff --git a/gdb/tui/tui-io.h b/gdb/tui/tui-io.h
index 8faf5b3d2ab..760532140f1 100644
--- a/gdb/tui/tui-io.h
+++ b/gdb/tui/tui-io.h
@@ -55,4 +55,9 @@ extern void tui_apply_style (WINDOW *w, ui_file_style style);
 extern struct ui_out *tui_out;
 extern cli_ui_out *tui_old_uiout;
 
+/* This should be called when the user has entered a command line in tui
+   mode.  Inject the newline into the output and move the cursor to the
+   next line.  */
+extern void tui_inject_newline_into_command_window ();
+
 #endif /* TUI_TUI_IO_H */
-- 
2.25.4