forked from Imagelibrary/binutils-gdb
e0700ba44c
String-like settings (var_string, var_filename, var_optional_filename, var_string_noescape) currently take a pointer to a `char *` storage variable (typically global) that holds the setting's value. I'd like to "mordernize" this by changing them to use an std::string for storage. An obvious reason is that string operations on std::string are often easier to write than with C strings. And they avoid having to do any manual memory management. Another interesting reason is that, with `char *`, nullptr and an empty string often both have the same meaning of "no value". String settings are initially nullptr (unless initialized otherwise). But when doing "set foo" (where `foo` is a string setting), the setting now points to an empty string. For example, solib_search_path is nullptr at startup, but points to an empty string after doing "set solib-search-path". This leads to some code that needs to check for both to check for "no value". Or some code that converts back and forth between NULL and "" when getting or setting the value. I find this very error-prone, because it is very easy to forget one or the other. With std::string, we at least know that the variable is not "NULL". There is only one way of representing an empty string setting, that is with an empty string. I was wondering whether the distinction between NULL and "" would be important for some setting, but it doesn't seem so. If that ever happens, it would be more C++-y and self-descriptive to use optional<string> anyway. Actually, there's one spot where this distinction mattered, it's in init_history, for the test gdb.base/gdbinit-history.exp. init_history sets the history filename to the default ".gdb_history" if it sees that the setting was never set - if history_filename is nullptr. If history_filename is an empty string, it means the setting was explicitly cleared, so it leaves it as-is. With the change to std::string, this distinction doesn't exist anymore. This can be fixed by moving the code that chooses a good default value for history_filename to _initialize_top. This is ran before -ex commands are processed, so an -ex command can then clear that value if needed (what gdb.base/gdbinit-history.exp tests). Another small improvement, in my opinion is that we can now easily give string parameters initial values, by simply initializing the global variables, instead of xstrdup-ing it in the _initialize function. In Python and Guile, when registering a string-like parameter, we allocate (with new) an std::string that is owned by the param_smob (in Guile) and the parmpy_object (in Python) objects. This patch started by changing all relevant add_setshow_* commands to take an `std::string *` instead of a `char **` and fixing everything that failed to build. That includes of course all string setting variable and their uses. string_option_def now uses an std::string also, because there's a connection between options and settings (see add_setshow_cmds_for_options). The add_path function in source.c is really complex and twisted, I'd rather not try to change it to work on an std::string right now. Instead, I added an overload that copies the std:string to a `char *` and back. This means more copying, but this is not used in a hot path at all, so I think it is acceptable. Change-Id: I92c50a1bdd8307141cdbacb388248e4e4fc08c93 Co-authored-by: Lancelot SIX <lsix@lancelotsix.com>
215 lines
6.6 KiB
C
215 lines
6.6 KiB
C
/* Command-line output logging for GDB, the GNU debugger.
|
|
|
|
Copyright (C) 2003-2021 Free Software Foundation, Inc.
|
|
|
|
This file is part of GDB.
|
|
|
|
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/>. */
|
|
|
|
#include "defs.h"
|
|
#include "gdbcmd.h"
|
|
#include "ui-out.h"
|
|
#include "interps.h"
|
|
#include "cli/cli-style.h"
|
|
|
|
static char *saved_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)
|
|
{
|
|
fprintf_filtered (file, _("The current logfile is \"%ps\".\n"),
|
|
styled_string (file_name_style.style (), value));
|
|
}
|
|
|
|
static bool logging_overwrite;
|
|
|
|
static void
|
|
maybe_warn_already_logging ()
|
|
{
|
|
if (saved_filename)
|
|
warning (_("Currently logging to %s. Turn the logging off and on to "
|
|
"make the new setting effective."), saved_filename);
|
|
}
|
|
|
|
static void
|
|
set_logging_overwrite (const char *args,
|
|
int from_tty, struct cmd_list_element *c)
|
|
{
|
|
maybe_warn_already_logging ();
|
|
}
|
|
|
|
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);
|
|
}
|
|
|
|
/* Value as configured by the user. */
|
|
static bool logging_redirect;
|
|
static bool debug_redirect;
|
|
|
|
static void
|
|
set_logging_redirect (const char *args,
|
|
int from_tty, struct cmd_list_element *c)
|
|
{
|
|
maybe_warn_already_logging ();
|
|
}
|
|
|
|
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 we've pushed output files, close them and pop them. */
|
|
static void
|
|
pop_output_files (void)
|
|
{
|
|
current_interp_set_logging (NULL, false, false);
|
|
|
|
/* Stay consistent with handle_redirections. */
|
|
if (!current_uiout->is_mi_like_p ())
|
|
current_uiout->redirect (NULL);
|
|
}
|
|
|
|
/* This is a helper for the `set logging' command. */
|
|
static void
|
|
handle_redirections (int from_tty)
|
|
{
|
|
if (saved_filename != NULL)
|
|
{
|
|
fprintf_unfiltered (gdb_stdout, "Already logging to %s.\n",
|
|
saved_filename);
|
|
return;
|
|
}
|
|
|
|
stdio_file_up log (new no_terminal_escape_file ());
|
|
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. */
|
|
if (from_tty)
|
|
{
|
|
if (!logging_redirect)
|
|
fprintf_unfiltered (gdb_stdout, "Copying output to %s.\n",
|
|
logging_filename.c_str ());
|
|
else
|
|
fprintf_unfiltered (gdb_stdout, "Redirecting output to %s.\n",
|
|
logging_filename.c_str ());
|
|
|
|
if (!debug_redirect)
|
|
fprintf_unfiltered (gdb_stdout, "Copying debug output to %s.\n",
|
|
logging_filename.c_str ());
|
|
else
|
|
fprintf_unfiltered (gdb_stdout, "Redirecting debug output to %s.\n",
|
|
logging_filename.c_str ());
|
|
}
|
|
|
|
saved_filename = xstrdup (logging_filename.c_str ());
|
|
|
|
/* Let the interpreter do anything it needs. */
|
|
current_interp_set_logging (std::move (log), logging_redirect,
|
|
debug_redirect);
|
|
|
|
/* Redirect the current ui-out object's output to the log. Use
|
|
gdb_stdout, not log, since the interpreter may have created a tee
|
|
that wraps the log. Don't do the redirect for MI, it confuses
|
|
MI's ui-out scheme. Note that we may get here with MI as current
|
|
interpreter, but with the current ui_out as a CLI ui_out, with
|
|
'-interpreter-exec console "set logging on"'. */
|
|
if (!current_uiout->is_mi_like_p ())
|
|
current_uiout->redirect (gdb_stdout);
|
|
}
|
|
|
|
static void
|
|
set_logging_on (const char *args, int from_tty)
|
|
{
|
|
const char *rest = args;
|
|
|
|
if (rest && *rest)
|
|
logging_filename = rest;
|
|
|
|
handle_redirections (from_tty);
|
|
}
|
|
|
|
static void
|
|
set_logging_off (const char *args, int from_tty)
|
|
{
|
|
if (saved_filename == NULL)
|
|
return;
|
|
|
|
pop_output_files ();
|
|
if (from_tty)
|
|
fprintf_unfiltered (gdb_stdout, "Done logging to %s.\n", saved_filename);
|
|
xfree (saved_filename);
|
|
saved_filename = NULL;
|
|
}
|
|
|
|
void _initialize_cli_logging ();
|
|
void
|
|
_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,
|
|
0, &setlist);
|
|
add_show_prefix_cmd ("logging", class_support,
|
|
_("Show logging options."), &show_logging_cmdlist,
|
|
0, &showlist);
|
|
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."),
|
|
set_logging_overwrite,
|
|
show_logging_overwrite,
|
|
&set_logging_cmdlist, &show_logging_cmdlist);
|
|
add_setshow_boolean_cmd ("redirect", class_support, &logging_redirect, _("\
|
|
Set the logging output mode."), _("\
|
|
Show the logging output mode."), _("\
|
|
If redirect is off, output will go to both the screen and the log file.\n\
|
|
If redirect is on, output will go only to the log file."),
|
|
set_logging_redirect,
|
|
show_logging_redirect,
|
|
&set_logging_cmdlist, &show_logging_cmdlist);
|
|
add_setshow_boolean_cmd ("debugredirect", class_support,
|
|
&debug_redirect, _("\
|
|
Set the logging debug output mode."), _("\
|
|
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,
|
|
&set_logging_cmdlist, &show_logging_cmdlist);
|
|
|
|
add_setshow_filename_cmd ("file", class_support, &logging_filename, _("\
|
|
Set the current logfile."), _("\
|
|
Show the current logfile."), _("\
|
|
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);
|
|
}
|