[gdb/cli] Improve show logging output
[binutils-gdb.git] / gdb / cli / cli-logging.c
index a58cdcec8766a831ef1d138492e9715903488e56..193a87331db3244c209172fb663e0cbd0360bda8 100644 (file)
@@ -1,6 +1,6 @@
 /* Command-line output logging for GDB, the GNU debugger.
 
-   Copyright (C) 2003-2020 Free Software Foundation, Inc.
+   Copyright (C) 2003-2022 Free Software Foundation, Inc.
 
    This file is part of GDB.
 
 #include "ui-out.h"
 #include "interps.h"
 #include "cli/cli-style.h"
+#include "cli/cli-decode.h"
 
-static char *saved_filename;
+static std::string saved_filename;
 
-static char *logging_filename;
+static std::string logging_filename = "gdb.txt";
 static void
 show_logging_filename (struct ui_file *file, int from_tty,
                       struct cmd_list_element *c, const char *value)
@@ -39,9 +40,9 @@ static bool logging_overwrite;
 static void
 maybe_warn_already_logging ()
 {
-  if (saved_filename)
+  if (!saved_filename.empty ())
     warning (_("Currently logging to %s.  Turn the logging off and on to "
-              "make the new setting effective."), saved_filename);
+              "make the new setting effective."), saved_filename.c_str ());
 }
 
 static void
@@ -55,10 +56,10 @@ static void
 show_logging_overwrite (struct ui_file *file, int from_tty,
                        struct cmd_list_element *c, const char *value)
 {
-  fprintf_filtered (file,
-                   _("Whether logging overwrites or "
-                     "appends to the log file is %s.\n"),
-                   value);
+  if (logging_overwrite)
+    fprintf_filtered (file, _("on: Logging overwrites the log file.\n"));
+  else
+    fprintf_filtered (file, _("off: Logging appends to the log file.\n"));
 }
 
 /* Value as configured by the user.  */
@@ -76,7 +77,25 @@ static void
 show_logging_redirect (struct ui_file *file, int from_tty,
                       struct cmd_list_element *c, const char *value)
 {
-  fprintf_filtered (file, _("The logging output mode is %s.\n"), value);
+  if (logging_redirect)
+    fprintf_filtered(file, _("on: Output will go only to the log file.\n"));
+  else
+    fprintf_filtered
+      (file,
+       _("off: Output will go to both the screen and the log file.\n"));
+}
+
+static void
+show_logging_debug_redirect (struct ui_file *file, int from_tty,
+                      struct cmd_list_element *c, const char *value)
+{
+  if (debug_redirect)
+    fprintf_filtered(file,
+                    _("on: Debug output will go only to the log file.\n"));
+  else
+    fprintf_filtered
+      (file,
+       _("off: Debug output will go to both the screen and the log file.\n"));
 }
 
 /* If we've pushed output files, close them and pop them.  */
@@ -94,15 +113,15 @@ pop_output_files (void)
 static void
 handle_redirections (int from_tty)
 {
-  if (saved_filename != NULL)
+  if (!saved_filename.empty ())
     {
       fprintf_unfiltered (gdb_stdout, "Already logging to %s.\n",
-                         saved_filename);
+                         saved_filename.c_str ());
       return;
     }
 
   stdio_file_up log (new no_terminal_escape_file ());
-  if (!log->open (logging_filename, logging_overwrite ? "w" : "a"))
+  if (!log->open (logging_filename.c_str (), logging_overwrite ? "w" : "a"))
     perror_with_name (_("set logging"));
 
   /* Redirects everything to gdb_stdout while this is running.  */
@@ -110,20 +129,20 @@ handle_redirections (int from_tty)
     {
       if (!logging_redirect)
        fprintf_unfiltered (gdb_stdout, "Copying output to %s.\n",
-                           logging_filename);
+                           logging_filename.c_str ());
       else
        fprintf_unfiltered (gdb_stdout, "Redirecting output to %s.\n",
-                           logging_filename);
+                           logging_filename.c_str ());
 
       if (!debug_redirect)
        fprintf_unfiltered (gdb_stdout, "Copying debug output to %s.\n",
-                           logging_filename);
+                           logging_filename.c_str ());
       else
        fprintf_unfiltered (gdb_stdout, "Redirecting debug output to %s.\n",
-                           logging_filename);
+                           logging_filename.c_str ());
     }
 
-  saved_filename = xstrdup (logging_filename);
+  saved_filename = logging_filename;
 
   /* Let the interpreter do anything it needs.  */
   current_interp_set_logging (std::move (log), logging_redirect,
@@ -145,24 +164,44 @@ set_logging_on (const char *args, int from_tty)
   const char *rest = args;
 
   if (rest && *rest)
-    {
-      xfree (logging_filename);
-      logging_filename = xstrdup (rest);
-    }
+    logging_filename = rest;
+
   handle_redirections (from_tty);
 }
 
 static void 
 set_logging_off (const char *args, int from_tty)
 {
-  if (saved_filename == NULL)
+  if (saved_filename.empty ())
     return;
 
   pop_output_files ();
   if (from_tty)
-    fprintf_unfiltered (gdb_stdout, "Done logging to %s.\n", saved_filename);
-  xfree (saved_filename);
-  saved_filename = NULL;
+    fprintf_unfiltered (gdb_stdout, "Done logging to %s.\n",
+                       saved_filename.c_str ());
+  saved_filename.clear ();
+}
+
+static bool logging_enabled;
+
+static void
+set_logging_enabled (const char *args,
+                    int from_tty, struct cmd_list_element *c)
+{
+  if (logging_enabled)
+    set_logging_on (args, from_tty);
+  else
+    set_logging_off (args, from_tty);
+}
+
+static void
+show_logging_enabled (struct ui_file *file, int from_tty,
+                      struct cmd_list_element *c, const char *value)
+{
+  if (logging_enabled)
+    fprintf_unfiltered (_("on: Logging is enabled.\n"));
+  else
+    fprintf_unfiltered (_("off: Logging is disabled.\n"));
 }
 
 void _initialize_cli_logging ();
@@ -171,19 +210,23 @@ _initialize_cli_logging ()
 {
   static struct cmd_list_element *set_logging_cmdlist, *show_logging_cmdlist;
 
-  add_basic_prefix_cmd ("logging", class_support,
-                       _("Set logging options."), &set_logging_cmdlist,
-                       "set logging ", 0, &setlist);
-  add_show_prefix_cmd ("logging", class_support,
-                      _("Show logging options."), &show_logging_cmdlist,
-                      "show logging ", 0, &showlist);
+  /* Set/show logging.  */
+  add_setshow_prefix_cmd ("logging", class_support,
+                         _("Set logging options."),
+                         _("Show logging options."),
+                         &set_logging_cmdlist, &show_logging_cmdlist,
+                         &setlist, &showlist);
+
+  /* Set/show logging overwrite.  */
   add_setshow_boolean_cmd ("overwrite", class_support, &logging_overwrite, _("\
 Set whether logging overwrites or appends to the log file."), _("\
 Show whether logging overwrites or appends to the log file."), _("\
-If set, logging overrides the log file."),
+If set, logging overwrites the log file."),
                           set_logging_overwrite,
                           show_logging_overwrite,
                           &set_logging_cmdlist, &show_logging_cmdlist);
+
+  /* Set/show logging redirect.  */
   add_setshow_boolean_cmd ("redirect", class_support, &logging_redirect, _("\
 Set the logging output mode."), _("\
 Show the logging output mode."), _("\
@@ -192,6 +235,8 @@ If redirect is on, output will go only to the log file."),
                           set_logging_redirect,
                           show_logging_redirect,
                           &set_logging_cmdlist, &show_logging_cmdlist);
+
+  /* Set/show logging debugredirect.  */
   add_setshow_boolean_cmd ("debugredirect", class_support,
                           &debug_redirect, _("\
 Set the logging debug output mode."), _("\
@@ -199,8 +244,10 @@ Show the logging debug output mode."), _("\
 If debug redirect is off, debug will go to both the screen and the log file.\n\
 If debug redirect is on, debug will go only to the log file."),
                           set_logging_redirect,
-                          show_logging_redirect,
+                          show_logging_debug_redirect,
                           &set_logging_cmdlist, &show_logging_cmdlist);
+
+  /* Set/show logging file.  */
   add_setshow_filename_cmd ("file", class_support, &logging_filename, _("\
 Set the current logfile."), _("\
 Show the current logfile."), _("\
@@ -208,10 +255,28 @@ The logfile is used when directing GDB's output."),
                            NULL,
                            show_logging_filename,
                            &set_logging_cmdlist, &show_logging_cmdlist);
-  add_cmd ("on", class_support, set_logging_on,
-          _("Enable logging."), &set_logging_cmdlist);
-  add_cmd ("off", class_support, set_logging_off,
-          _("Disable logging."), &set_logging_cmdlist);
 
-  logging_filename = xstrdup ("gdb.txt");
+  /* Set/show logging enabled.  */
+  set_show_commands setshow_logging_enabled_cmds
+    = add_setshow_boolean_cmd ("enabled", class_support, &logging_enabled,
+                              _("Enable logging."),
+                              _("Show whether logging is enabled."),
+                              _("When on, enable logging."),
+                              set_logging_enabled,
+                              show_logging_enabled,
+                              &set_logging_cmdlist, &show_logging_cmdlist);
+
+  /* Set logging on, deprecated alias.  */
+  cmd_list_element *set_logging_on_cmd
+    = add_alias_cmd ("on", setshow_logging_enabled_cmds.set, class_support,
+                    false, &set_logging_cmdlist);
+  deprecate_cmd (set_logging_on_cmd, "set logging enabled on");
+  set_logging_on_cmd->default_args = "on";
+
+  /* Set logging off, deprecated alias.  */
+  cmd_list_element *set_logging_off_cmd
+    = add_alias_cmd ("off", setshow_logging_enabled_cmds.set, class_support,
+                    false, &set_logging_cmdlist);
+  deprecate_cmd (set_logging_off_cmd, "set logging enabled off");
+  set_logging_off_cmd->default_args = "off";
 }