Container of environment variables. More...

#include <sbuild-environment.h>

Inheritance diagram for sbuild::environment:

Collaboration diagram for sbuild::environment:

Public Member Functions
	environment ()
	The constructor.

	environment (char **environment)
	The constructor. More...

	~environment ()
	The destructor.

void	set_filter (regex const &filter)
	Set environment filter. More...

regex const &	get_filter () const
	Get environment filter. More...

void	add (char **environment)
	Add environment variables. More...

void	add (environment const &environment)
	Add environment variables. More...

void	add (value_type const &value)
	Add environment variable. More...

void	add (std::string const &name, std::string const &value)
	Add environment variable. More...

template<typename T >
void	add (std::string const &name, T const &value)
	Add environment variable. More...

void	add (std::string const &value)
	Add environment variable. More...

void	remove (char **environment)
	Remove environment variables. More...

void	remove (environment const &environment)
	Remove environment variables. More...

void	remove (std::string const &value)
	Remove environment variable. More...

void	remove (value_type const &value)
	Remove environment variable. More...

template<typename T >
bool	get (std::string const &name, T &value) const
	Get the value of an environment variable. More...

char **	get_strv () const
	Get the evironment variables as a string vector. More...

template<typename T >
environment &	operator+= (T const &rhs)
	Add variables to the environment. More...

template<typename T >
environment &	operator-= (T const &rhs)
	Remove variables from the environment. More...

Private Attributes
regex	filter
	Filter regex.

Friends
template<typename T >
environment	operator+ (environment const &lhs, T const &rhs)
	Add variables to the environment. More...

template<typename T >
environment	operator- (environment const &lhs, T const &rhs)
	Remove variables from the environment. More...

template<class charT , class traits >
std::basic_ostream< charT, traits > &	operator<< (std::basic_ostream< charT, traits > &stream, environment const &rhs)
	Output the environment to an ostream. More...

Detailed Description

Container of environment variables.

Constructor & Destructor Documentation

environment::environment ( char ** environment )

The constructor.

Parameters

environment the environment to set.

References add().

Member Function Documentation

void environment::add ( char ** environment )

Add environment variables.

Any existing variables sharing the name of a new value will be replaced.

Parameters

environment the environment variables to add. This is a null-terminated array of pointers to char.

Referenced by add(), environment(), sbuild::session::get_login_command(), sbuild::auth::get_minimal_environment(), operator+=(), sbuild::session::setup_chroot(), sbuild::chroot_directory_base::setup_env(), sbuild::chroot_block_device_base::setup_env(), sbuild::chroot_facet_userdata::setup_env(), sbuild::chroot_loopback::setup_env(), sbuild::chroot_lvm_snapshot::setup_env(), sbuild::chroot_facet_session::setup_env(), sbuild::chroot_file::setup_env(), sbuild::chroot_btrfs_snapshot::setup_env(), sbuild::chroot_facet_mountable::setup_env(), sbuild::chroot_facet_union::setup_env(), and sbuild::chroot::setup_env().

Here is the caller graph for this function:

void environment::add ( environment const & environment )

Add environment variables.

Any existing variables sharing the name of a new value will be replaced.

Parameters

environment the environment variables to add.

References add().

void environment::add ( value_type const & value )

Add environment variable.

Any existing variable sharing the name will be replaced.

Parameters

value the environment variable to add.

References sbuild::DEBUG_INFO, sbuild::DEBUG_NOTICE, filter, sbuild::log_debug(), and sbuild::regex_search().

void sbuild::environment::add	(	std::string const &	name,
		std::string const &	value
	)

inline

Add environment variable.

Any existing variable sharing the name will be replaced.

Parameters

name	the environment variable name
value	the environment variable value to add.

References add().

template<typename T >

void sbuild::environment::add	(	std::string const &	name,
		T const &	value
	)

inline

Add environment variable.

Any existing variable sharing the name will be replaced.

Parameters

name	the environment variable name
value	the environment variable value to add.

References add().

void environment::add ( std::string const & value )

Add environment variable.

Any existing variable sharing the name will be replaced.

Parameters

value the environment variable to add. This is a string in the form key=value.

References add().

template<typename T >

bool sbuild::environment::get	(	std::string const &	name,
		T &	value
	)		const

inline

Get the value of an environment variable.

Parameters

name	the name of the environment variable.
value	the variable to store the value in on success.

Returns: true on success, false if the variable does not exist, or there is a parse error.

References sbuild::DEBUG_INFO, sbuild::DEBUG_NOTICE, sbuild::log_debug(), sbuild::log_warning(), and sbuild::parse_value().

Referenced by sbuild::session::get_login_directories(), sbuild::session::get_user_command(), and sbuild::chroot_facet_userdata::setup_env().

Here is the caller graph for this function:

regex const & environment::get_filter ( ) const

Get environment filter.

Returns: the filter regex.

References filter.

char ** environment::get_strv ( ) const

Get the evironment variables as a string vector.

This form is suitable for use as an envp argument with execve, for example.

Returns: a newly-allocated string vector. This is allocated with new, and should be freed with strv_delete().

Referenced by sbuild::exec().

Here is the caller graph for this function:

template<typename T >

environment& sbuild::environment::operator+= ( T const & rhs )

inline

Add variables to the environment.

Parameters

rhs	the values to add.

Returns: the modified environment.

References add().

template<typename T >

environment& sbuild::environment::operator-= ( T const & rhs )

inline

Remove variables from the environment.

Parameters

rhs	the values to remove.

Returns: the modified environment.

void environment::remove ( char ** environment )

Remove environment variables.

Any variables sharing the names of a specified value will be removed.

Parameters

environment the environment variables to remove. This is a null-terminated array of pointers to char.

Referenced by sbuild::auth::get_complete_environment().

Here is the caller graph for this function:

void environment::remove ( environment const & environment )

Remove environment variables.

Any variables sharing the names of a specified value will be removed.

Parameters

environment the environment variables to remove.

void environment::remove ( std::string const & value )

Remove environment variable.

Any variable sharing the name of the specified value will be removed.

Parameters

value the environment variable to remove.

void environment::remove ( value_type const & value )

Remove environment variable.

Any variable sharing the name of the specified value will be removed.

Parameters

value the environment variable to remove.

void environment::set_filter ( regex const & filter )

Set environment filter.

If the environment variable name matches the regex when add() is called, addition will be .

The default filter is to allow all strings.

If the regex contains errors, an exception will be thrown.

Parameters

filter the filter regex.

References filter.

Referenced by sbuild::session::run_child().

Here is the caller graph for this function:

Friends And Related Function Documentation

template<typename T >

environment operator+	(	environment const &	lhs,
		T const &	rhs
	)

friend

Add variables to the environment.

Parameters

lhs	the environment to add to.
rhs	the values to add.

Returns: the new environment.

template<typename T >

environment operator-	(	environment const &	lhs,
		T const &	rhs
	)

friend

Remove variables from the environment.

Parameters

lhs	the environment to remove from.
rhs	the values to remove.

Returns: the new environment.

template<class charT , class traits >

std::basic_ostream<charT,traits>& operator<<	(	std::basic_ostream< charT, traits > &	stream,
		environment const &	rhs
	)

friend

Output the environment to an ostream.

Parameters

stream	the stream to output to.
rhs	the environment to output.

Returns: the stream.

The documentation for this class was generated from the following files:

sbuild/sbuild-environment.h
sbuild/sbuild-environment.cc

Public Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation