binutils-gdb/gdb/mi/mi-cmd-env.c
Sergio Durigan Junior 9a6c7d9c02 C++ify gdb/common/environ.c
As part of the preparation necessary for my upcoming task, I'd like to
propose that we turn gdb_environ into a class.  The approach taken
here is simple: the class gdb_environ contains everything that is
needed to manipulate the environment variables.  These variables are
stored in an std::vector<char *>, which can be converted to a 'char
**' and passed as argument to functions that need it.

The usage has not changed much.  As per Pedro's suggestion, this class
uses a static factory method initialization.  This means that when an
instance is created, it is initially empty.  When needed, it has to be
initialized using the static method 'from_host_environ'.

As mentioned before, this is a preparation for an upcoming work that I
will be posting in the next few weeks or so.  For that work, I'll
probably create another data structure that will contain all the
environment variables that were set by the user using the 'set
environment' command, because I'll need access to them.  This will be
much easier with the class-ification of gdb_environ.

As noted, this has been regression-tested with the new version of
environ.exp and no regressions were found.

gdb/ChangeLog:
2017-06-20  Sergio Durigan Junior  <sergiodj@redhat.com>

	* Makefile.in (SUBDIR_UNITTESTS_SRCS): Add
	'unittests/environ-selftests.c'.
	(SUBDIR_UNITTESTS_OBS): Add 'environ-selftests.o'.
	* charset.c (find_charset_names): Declare object 'iconv_env'.
	Update code to use 'iconv_env' object.  Remove call to
	'free_environ'.
	* common/environ.c: Include <utility>.
	(make_environ): Delete function.
	(free_environ): Delete function.
	(gdb_environ::clear): New function.
	(gdb_environ::operator=): New function.
	(gdb_environ::get): Likewise.
	(environ_vector): Delete function.
	(set_in_environ): Delete function.
	(gdb_environ::set): New function.
	(unset_in_environ): Delete function.
	(gdb_environ::unset): New function.
	(gdb_environ::envp): Likewise.
	* common/environ.h: Include <vector>.
	(struct gdb_environ): Delete; transform into...
	(class gdb_environ): ... this class.
	(free_environ): Delete prototype.
	(init_environ, get_in_environ, set_in_environ, unset_in_environ,
	environ_vector): Likewise.
	* infcmd.c (run_command_1): Update code to call
	'envp' from 'gdb_environ' class.
	(environment_info): Update code to call methods from 'gdb_environ'
	class.
	(unset_environment_command): Likewise.
	(path_info): Likewise.
	(path_command): Likewise.
	* inferior.c (inferior::~inferior): Delete call to 'free_environ'.
	(inferior::inferior): Initialize 'environment' using the host's
	information.
	* inferior.h: Remove forward declaration of 'struct gdb_environ'.
	Include "environ.h".
	(class inferior) <environment>: Change type from 'struct
	gdb_environ' to 'gdb_environ'.
	* mi/mi-cmd-env.c (mi_cmd_env_path): Update code to call
	methods from 'gdb_environ' class.
	* solib.c (solib_find_1): Likewise
	* unittests/environ-selftests.c: New file.

gdb/gdbserver/ChangeLog:
2017-06-20  Sergio Durigan Junior  <sergiodj@redhat.com>

	* linux-low.c (linux_create_inferior): Adjust code to access the
	environment information via 'gdb_environ' class.
	* lynx-low.c (lynx_create_inferior): Likewise.
	* server.c (our_environ): Make it an instance of 'gdb_environ'.
	(get_environ): Return a pointer to 'our_environ'.
	(captured_main): Initialize 'our_environ'.
	* server.h (get_environ): Adjust prototype.
	* spu-low.c (spu_create_inferior): Adjust code to access the
	environment information via 'gdb_environ' class.
2017-06-20 08:59:27 -04:00

287 lines
6.6 KiB
C

/* MI Command Set - environment commands.
Copyright (C) 2002-2017 Free Software Foundation, Inc.
Contributed by Red Hat 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 "inferior.h"
#include "value.h"
#include "mi-out.h"
#include "mi-cmds.h"
#include "mi-getopt.h"
#include "symtab.h"
#include "target.h"
#include "environ.h"
#include "command.h"
#include "ui-out.h"
#include "top.h"
#include <sys/stat.h>
static void env_mod_path (char *dirname, char **which_path);
extern void _initialize_mi_cmd_env (void);
static const char path_var_name[] = "PATH";
static char *orig_path = NULL;
/* The following is copied from mi-main.c so for m1 and below we can
perform old behavior and use cli commands. If ARGS is non-null,
append it to the CMD. */
static void
env_execute_cli_command (const char *cmd, const char *args)
{
if (cmd != 0)
{
struct cleanup *old_cleanups;
char *run;
if (args != NULL)
run = xstrprintf ("%s %s", cmd, args);
else
run = xstrdup (cmd);
old_cleanups = make_cleanup (xfree, run);
execute_command ( /*ui */ run, 0 /*from_tty */ );
do_cleanups (old_cleanups);
return;
}
}
/* Print working directory. */
void
mi_cmd_env_pwd (const char *command, char **argv, int argc)
{
struct ui_out *uiout = current_uiout;
if (argc > 0)
error (_("-environment-pwd: No arguments allowed"));
if (mi_version (uiout) < 2)
{
env_execute_cli_command ("pwd", NULL);
return;
}
/* Otherwise the mi level is 2 or higher. */
if (! getcwd (gdb_dirbuf, sizeof (gdb_dirbuf)))
error (_("-environment-pwd: error finding name of working directory: %s"),
safe_strerror (errno));
uiout->field_string ("cwd", gdb_dirbuf);
}
/* Change working directory. */
void
mi_cmd_env_cd (const char *command, char **argv, int argc)
{
if (argc == 0 || argc > 1)
error (_("-environment-cd: Usage DIRECTORY"));
env_execute_cli_command ("cd", argv[0]);
}
static void
env_mod_path (char *dirname, char **which_path)
{
if (dirname == 0 || dirname[0] == '\0')
return;
/* Call add_path with last arg 0 to indicate not to parse for
separator characters. */
add_path (dirname, which_path, 0);
}
/* Add one or more directories to start of executable search path. */
void
mi_cmd_env_path (const char *command, char **argv, int argc)
{
struct ui_out *uiout = current_uiout;
char *exec_path;
const char *env;
int reset = 0;
int oind = 0;
int i;
char *oarg;
enum opt
{
RESET_OPT
};
static const struct mi_opt opts[] =
{
{"r", RESET_OPT, 0},
{ 0, 0, 0 }
};
dont_repeat ();
if (mi_version (uiout) < 2)
{
for (i = argc - 1; i >= 0; --i)
env_execute_cli_command ("path", argv[i]);
return;
}
/* Otherwise the mi level is 2 or higher. */
while (1)
{
int opt = mi_getopt ("-environment-path", argc, argv, opts,
&oind, &oarg);
if (opt < 0)
break;
switch ((enum opt) opt)
{
case RESET_OPT:
reset = 1;
break;
}
}
argv += oind;
argc -= oind;
if (reset)
{
/* Reset implies resetting to original path first. */
exec_path = xstrdup (orig_path);
}
else
{
/* Otherwise, get current path to modify. */
env = current_inferior ()->environment.get (path_var_name);
/* Can be null if path is not set. */
if (!env)
env = "";
exec_path = xstrdup (env);
}
for (i = argc - 1; i >= 0; --i)
env_mod_path (argv[i], &exec_path);
current_inferior ()->environment.set (path_var_name, exec_path);
xfree (exec_path);
env = current_inferior ()->environment.get (path_var_name);
uiout->field_string ("path", env);
}
/* Add zero or more directories to the front of the source path. */
void
mi_cmd_env_dir (const char *command, char **argv, int argc)
{
struct ui_out *uiout = current_uiout;
int i;
int oind = 0;
int reset = 0;
char *oarg;
enum opt
{
RESET_OPT
};
static const struct mi_opt opts[] =
{
{"r", RESET_OPT, 0},
{ 0, 0, 0 }
};
dont_repeat ();
if (mi_version (uiout) < 2)
{
for (i = argc - 1; i >= 0; --i)
env_execute_cli_command ("dir", argv[i]);
return;
}
/* Otherwise mi level is 2 or higher. */
while (1)
{
int opt = mi_getopt ("-environment-directory", argc, argv, opts,
&oind, &oarg);
if (opt < 0)
break;
switch ((enum opt) opt)
{
case RESET_OPT:
reset = 1;
break;
}
}
argv += oind;
argc -= oind;
if (reset)
{
/* Reset means setting to default path first. */
xfree (source_path);
init_source_path ();
}
for (i = argc - 1; i >= 0; --i)
env_mod_path (argv[i], &source_path);
uiout->field_string ("source-path", source_path);
forget_cached_source_info ();
}
/* Set the inferior terminal device name. */
void
mi_cmd_inferior_tty_set (const char *command, char **argv, int argc)
{
set_inferior_io_terminal (argv[0]);
}
/* Print the inferior terminal device name. */
void
mi_cmd_inferior_tty_show (const char *command, char **argv, int argc)
{
const char *inferior_io_terminal = get_inferior_io_terminal ();
if ( !mi_valid_noargs ("-inferior-tty-show", argc, argv))
error (_("-inferior-tty-show: Usage: No args"));
if (inferior_io_terminal)
current_uiout->field_string ("inferior_tty_terminal", inferior_io_terminal);
}
void
_initialize_mi_cmd_env (void)
{
const char *env;
/* We want original execution path to reset to, if desired later.
At this point, current inferior is not created, so cannot use
current_inferior ()->environment. We use getenv here because it
is not necessary to create a whole new gdb_environ just for one
variable. */
env = getenv (path_var_name);
/* Can be null if path is not set. */
if (!env)
env = "";
orig_path = xstrdup (env);
}