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