1*11be35a1SLionel Sambuc // 2*11be35a1SLionel Sambuc // Automated Testing Framework (atf) 3*11be35a1SLionel Sambuc // 4*11be35a1SLionel Sambuc // Copyright (c) 2007 The NetBSD Foundation, Inc. 5*11be35a1SLionel Sambuc // All rights reserved. 6*11be35a1SLionel Sambuc // 7*11be35a1SLionel Sambuc // Redistribution and use in source and binary forms, with or without 8*11be35a1SLionel Sambuc // modification, are permitted provided that the following conditions 9*11be35a1SLionel Sambuc // are met: 10*11be35a1SLionel Sambuc // 1. Redistributions of source code must retain the above copyright 11*11be35a1SLionel Sambuc // notice, this list of conditions and the following disclaimer. 12*11be35a1SLionel Sambuc // 2. Redistributions in binary form must reproduce the above copyright 13*11be35a1SLionel Sambuc // notice, this list of conditions and the following disclaimer in the 14*11be35a1SLionel Sambuc // documentation and/or other materials provided with the distribution. 15*11be35a1SLionel Sambuc // 16*11be35a1SLionel Sambuc // THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND 17*11be35a1SLionel Sambuc // CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, 18*11be35a1SLionel Sambuc // INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 19*11be35a1SLionel Sambuc // MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 20*11be35a1SLionel Sambuc // IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY 21*11be35a1SLionel Sambuc // DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22*11be35a1SLionel Sambuc // DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE 23*11be35a1SLionel Sambuc // GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 24*11be35a1SLionel Sambuc // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER 25*11be35a1SLionel Sambuc // IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 26*11be35a1SLionel Sambuc // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN 27*11be35a1SLionel Sambuc // IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 28*11be35a1SLionel Sambuc // 29*11be35a1SLionel Sambuc 30*11be35a1SLionel Sambuc #if !defined(_ATF_CXX_ENV_HPP_) 31*11be35a1SLionel Sambuc #define _ATF_CXX_ENV_HPP_ 32*11be35a1SLionel Sambuc 33*11be35a1SLionel Sambuc #include <string> 34*11be35a1SLionel Sambuc 35*11be35a1SLionel Sambuc namespace atf { 36*11be35a1SLionel Sambuc namespace env { 37*11be35a1SLionel Sambuc 38*11be35a1SLionel Sambuc // ------------------------------------------------------------------------ 39*11be35a1SLionel Sambuc // Free functions. 40*11be35a1SLionel Sambuc // ------------------------------------------------------------------------ 41*11be35a1SLionel Sambuc 42*11be35a1SLionel Sambuc //! 43*11be35a1SLionel Sambuc //! \brief Returns the value of an environment variable. 44*11be35a1SLionel Sambuc //! 45*11be35a1SLionel Sambuc //! Returns the value of the specified environment variable. The variable 46*11be35a1SLionel Sambuc //! must be defined. 47*11be35a1SLionel Sambuc //! 48*11be35a1SLionel Sambuc std::string get(const std::string&); 49*11be35a1SLionel Sambuc 50*11be35a1SLionel Sambuc //! 51*11be35a1SLionel Sambuc //! \brief Checks if the environment has a variable. 52*11be35a1SLionel Sambuc //! 53*11be35a1SLionel Sambuc //! Checks if the environment has a given variable. 54*11be35a1SLionel Sambuc //! 55*11be35a1SLionel Sambuc bool has(const std::string&); 56*11be35a1SLionel Sambuc 57*11be35a1SLionel Sambuc //! 58*11be35a1SLionel Sambuc //! \brief Sets an environment variable to a given value. 59*11be35a1SLionel Sambuc //! 60*11be35a1SLionel Sambuc //! Sets the specified environment variable to the given value. Note that 61*11be35a1SLionel Sambuc //! variables set to the empty string are different to undefined ones. 62*11be35a1SLionel Sambuc //! 63*11be35a1SLionel Sambuc //! Be aware that this alters the program's global status, which in general 64*11be35a1SLionel Sambuc //! is a bad thing to do due to the side-effects it may have. There are 65*11be35a1SLionel Sambuc //! some legitimate usages for this function, though. 66*11be35a1SLionel Sambuc //! 67*11be35a1SLionel Sambuc void set(const std::string&, const std::string&); 68*11be35a1SLionel Sambuc 69*11be35a1SLionel Sambuc //! 70*11be35a1SLionel Sambuc //! \brief Unsets an environment variable. 71*11be35a1SLionel Sambuc //! 72*11be35a1SLionel Sambuc //! Unsets the specified environment variable Note that undefined 73*11be35a1SLionel Sambuc //! variables are different to those defined but set to an empty value. 74*11be35a1SLionel Sambuc //! 75*11be35a1SLionel Sambuc //! Be aware that this alters the program's global status, which in general 76*11be35a1SLionel Sambuc //! is a bad thing to do due to the side-effects it may have. There are 77*11be35a1SLionel Sambuc //! some legitimate usages for this function, though. 78*11be35a1SLionel Sambuc //! 79*11be35a1SLionel Sambuc void unset(const std::string&); 80*11be35a1SLionel Sambuc 81*11be35a1SLionel Sambuc } // namespace env 82*11be35a1SLionel Sambuc } // namespace atf 83*11be35a1SLionel Sambuc 84*11be35a1SLionel Sambuc #endif // !defined(_ATF_CXX_ENV_HPP_) 85