sbuild::environment Class Reference

Container of environment variables. More...

#include <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 (const regex &filter)
	Set environment filter. More...
regex const &	get_filter () const
	Get environment filter. More...
void	add (char **environment)
	Add environment variables. More...
void	add (const environment &environment)
	Add environment variables. More...
void	add (const value_type &value)
	Add environment variable. More...
void	add (const std::string &name, const std::string &value)
	Add environment variable. More...
template<typename T >
void	add (const std::string &name, T const &value)
	Add environment variable. More...
void	add (const std::string &value)
	Add environment variable. More...
void	remove (char **environment)
	Remove environment variables. More...
void	remove (const environment &environment)
	Remove environment variables. More...
void	remove (const std::string &value)
	Remove environment variable. More...
void	remove (const value_type &value)
	Remove environment variable. More...
template<typename T >
bool	get (const std::string &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+ (const environment &lhs, T const &rhs)
	Add variables to the environment. More...
template<typename T >
environment	operator- (const environment &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, const environment &rhs)
	Output the environment to an ostream. More...

Additional Inherited Members
Public Attributes inherited from std::map< K, T >
K	keys
	STL member.
T	elements
	STL member.

Detailed Description

Container of environment variables.

Constructor & Destructor Documentation

sbuild::environment::environment

(

char **

environment)

The constructor.

Parameters

environment

the environment to set.

References add().

Member Function Documentation

void sbuild::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::auth::get_minimal_environment(), operator+=(), sbuild::session::setup_chroot(), sbuild::chroot::facet::directory_base::setup_env(), sbuild::chroot::facet::userdata::setup_env(), sbuild::chroot::facet::block_device_base::setup_env(), sbuild::chroot::facet::loopback::setup_env(), sbuild::chroot::facet::session::setup_env(), sbuild::chroot::facet::lvm_snapshot::setup_env(), sbuild::chroot::facet::mountable::setup_env(), sbuild::chroot::facet::file::setup_env(), sbuild::chroot::facet::btrfs_snapshot::setup_env(), sbuild::chroot::facet::unshare::setup_env(), sbuild::chroot::facet::fsunion::setup_env(), and sbuild::chroot::chroot::setup_env().

Here is the caller graph for this function:

void sbuild::environment::add

(

const environment &

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 sbuild::environment::add

(

const value_type &

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 ( const std::string &  name, const std::string &  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 ( const std::string &  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 sbuild::environment::add

(

const std::string &

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 ( const std::string &  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 & sbuild::environment::get_filter

(

)

const

Get environment filter.

Returns

the filter regex.

References filter.

char ** sbuild::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 sbuild::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::auth::get_complete_environment().

Here is the caller graph for this function:

void sbuild::environment::remove

(

const environment &

environment)

Remove environment variables.

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

Parameters

environment

the environment variables to remove.

void sbuild::environment::remove

(

const std::string &

value)

Remove environment variable.

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

Parameters

value

the environment variable to remove.

void sbuild::environment::remove

(

const value_type &

value)

Remove environment variable.

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

Parameters

value

the environment variable to remove.

void sbuild::environment::set_filter

(

const regex &

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+ ( const environment &  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- ( const environment &  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, const environment &  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:

• lib/sbuild/environment.h
• lib/sbuild/environment.cc