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