[RFA,19/23] Replace do_restore_instream_cleanup with scoped_restore

Message ID 20170503224626.2818-20-tom@tromey.com
State New, archived
Headers

Commit Message

Tom Tromey May 3, 2017, 10:46 p.m. UTC
  This changes the users of do_restore_instream_cleanup to use a
scoped_restore instead.  This patch is broken out because it warrants
some additional attention: in particular it's unclear to me whether
current_ui can change in the body of these functions -- but if it can,
then the cleanup would have modified a different UI's instream member.

2017-05-02  Tom Tromey  <tom@tromey.com>

	* top.h (do_restore_instream_cleanup): Remove.
	* top.c (do_restore_instream_cleanup): Remove.
	(read_command_file): Use scoped_restore.
	* cli/cli-script.c (execute_user_command): Use scoped_restore.
---
 gdb/ChangeLog        |  7 +++++++
 gdb/cli/cli-script.c |  6 ++----
 gdb/top.c            | 19 ++-----------------
 gdb/top.h            |  2 --
 4 files changed, 11 insertions(+), 23 deletions(-)
  

Comments

Pedro Alves June 5, 2017, 1:49 p.m. UTC | #1
On 05/03/2017 11:46 PM, Tom Tromey wrote:
> This changes the users of do_restore_instream_cleanup to use a
> scoped_restore instead.  This patch is broken out because it warrants
> some additional attention: in particular it's unclear to me whether
> current_ui can change in the body of these functions -- but if it can,
> then the cleanup would have modified a different UI's instream member.
> 

The only places that change the current UI without restoring it
back are the top level event loop code that reacts to stdin input
and signal handlers (stdin_event_handler / invoke_async_signal_handlers).
Everything else that temporarily switches UI switches back before
returning, using scoped_restore.  (This includes nested even loops like
wait_sync_command_done.)

> 2017-05-02  Tom Tromey  <tom@tromey.com>
> 
> 	* top.h (do_restore_instream_cleanup): Remove.
> 	* top.c (do_restore_instream_cleanup): Remove.
> 	(read_command_file): Use scoped_restore.
> 	* cli/cli-script.c (execute_user_command): Use scoped_restore.

OK.

Thanks,
Pedro Alves
  

Patch

diff --git a/gdb/ChangeLog b/gdb/ChangeLog
index a27feda..5e37c48 100644
--- a/gdb/ChangeLog
+++ b/gdb/ChangeLog
@@ -1,5 +1,12 @@ 
 2017-05-02  Tom Tromey  <tom@tromey.com>
 
+	* top.h (do_restore_instream_cleanup): Remove.
+	* top.c (do_restore_instream_cleanup): Remove.
+	(read_command_file): Use scoped_restore.
+	* cli/cli-script.c (execute_user_command): Use scoped_restore.
+
+2017-05-02  Tom Tromey  <tom@tromey.com>
+
 	* cli/cli-script.c (execute_user_command)
 	(execute_control_command): Use scoped_restore.
 
diff --git a/gdb/cli/cli-script.c b/gdb/cli/cli-script.c
index c0e6716..b594630 100644
--- a/gdb/cli/cli-script.c
+++ b/gdb/cli/cli-script.c
@@ -377,7 +377,6 @@  execute_user_command (struct cmd_list_element *c, char *args)
 {
   struct ui *ui = current_ui;
   struct command_line *cmdlines;
-  struct cleanup *old_chain;
   enum command_control_type ret;
   static int user_call_depth = 0;
   extern unsigned int max_user_call_depth;
@@ -396,8 +395,8 @@  execute_user_command (struct cmd_list_element *c, char *args)
 
   /* Set the instream to 0, indicating execution of a
      user-defined function.  */
-  old_chain = make_cleanup (do_restore_instream_cleanup, ui->instream);
-  ui->instream = NULL;
+  scoped_restore restore_instream
+    = make_scoped_restore (&ui->instream, nullptr);
 
   scoped_restore save_async = make_scoped_restore (&current_ui->async, 0);
 
@@ -413,7 +412,6 @@  execute_user_command (struct cmd_list_element *c, char *args)
 	}
       cmdlines = cmdlines->next;
     }
-  do_cleanups (old_chain);
 }
 
 /* This function is called every time GDB prints a prompt.  It ensures
diff --git a/gdb/top.c b/gdb/top.c
index 862016a..6038366 100644
--- a/gdb/top.c
+++ b/gdb/top.c
@@ -443,27 +443,14 @@  quit_cover (void)
    event-top.c into this file, top.c.  */
 /* static */ const char *source_file_name;
 
-/* Clean up on error during a "source" command (or execution of a
-   user-defined command).  */
-
-void
-do_restore_instream_cleanup (void *stream)
-{
-  struct ui *ui = current_ui;
-
-  /* Restore the previous input stream.  */
-  ui->instream = (FILE *) stream;
-}
-
 /* Read commands from STREAM.  */
 void
 read_command_file (FILE *stream)
 {
   struct ui *ui = current_ui;
-  struct cleanup *cleanups;
 
-  cleanups = make_cleanup (do_restore_instream_cleanup, ui->instream);
-  ui->instream = stream;
+  scoped_restore save_instream
+    = make_scoped_restore (&ui->instream, stream);
 
   /* Read commands from `instream' and execute them until end of file
      or error reading instream.  */
@@ -478,8 +465,6 @@  read_command_file (FILE *stream)
 	break;
       command_handler (command);
     }
-
-  do_cleanups (cleanups);
 }
 
 void (*pre_init_ui_hook) (void);
diff --git a/gdb/top.h b/gdb/top.h
index 5d7cb1f..4579889 100644
--- a/gdb/top.h
+++ b/gdb/top.h
@@ -290,8 +290,6 @@  extern void show_history (char *, int);
 
 extern void set_verbose (char *, int, struct cmd_list_element *);
 
-extern void do_restore_instream_cleanup (void *stream);
-
 extern char *handle_line_of_input (struct buffer *cmd_line_buffer,
 				   char *rl, int repeat,
 				   const char *annotation_suffix);