9a6c7d9c02
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.
81 lines
2.4 KiB
C++
81 lines
2.4 KiB
C++
/* Header for environment manipulation library.
|
|
Copyright (C) 1989-2017 Free Software Foundation, Inc.
|
|
|
|
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/>. */
|
|
|
|
#if !defined (ENVIRON_H)
|
|
#define ENVIRON_H 1
|
|
|
|
#include <vector>
|
|
|
|
/* Class that represents the environment variables as seen by the
|
|
inferior. */
|
|
|
|
class gdb_environ
|
|
{
|
|
public:
|
|
/* Regular constructor and destructor. */
|
|
gdb_environ ()
|
|
{
|
|
/* Make sure that the vector contains at least a NULL element.
|
|
If/when we add more variables to it, NULL will always be the
|
|
last element. */
|
|
m_environ_vector.push_back (NULL);
|
|
}
|
|
|
|
~gdb_environ ()
|
|
{
|
|
clear ();
|
|
}
|
|
|
|
/* Move constructor. */
|
|
gdb_environ (gdb_environ &&e)
|
|
: m_environ_vector (std::move (e.m_environ_vector))
|
|
{
|
|
/* Make sure that the moved-from vector is left at a valid
|
|
state (only one NULL element). */
|
|
e.m_environ_vector.clear ();
|
|
e.m_environ_vector.push_back (NULL);
|
|
}
|
|
|
|
/* Move assignment. */
|
|
gdb_environ &operator= (gdb_environ &&e);
|
|
|
|
/* Create a gdb_environ object using the host's environment
|
|
variables. */
|
|
static gdb_environ from_host_environ ();
|
|
|
|
/* Clear the environment variables stored in the object. */
|
|
void clear ();
|
|
|
|
/* Return the value in the environment for the variable VAR. The
|
|
returned pointer is only valid as long as the gdb_environ object
|
|
is not modified. */
|
|
const char *get (const char *var) const;
|
|
|
|
/* Store VAR=VALUE in the environment. */
|
|
void set (const char *var, const char *value);
|
|
|
|
/* Unset VAR in environment. */
|
|
void unset (const char *var);
|
|
|
|
/* Return the environment vector represented as a 'char **'. */
|
|
char **envp () const;
|
|
|
|
private:
|
|
/* A vector containing the environment variables. */
|
|
std::vector<char *> m_environ_vector;
|
|
};
|
|
|
|
#endif /* defined (ENVIRON_H) */
|