1 // Copyright 2010 The Kyua Authors. 2 // All rights reserved. 3 // 4 // Redistribution and use in source and binary forms, with or without 5 // modification, are permitted provided that the following conditions are 6 // met: 7 // 8 // * Redistributions of source code must retain the above copyright 9 // notice, this list of conditions and the following disclaimer. 10 // * Redistributions in binary form must reproduce the above copyright 11 // notice, this list of conditions and the following disclaimer in the 12 // documentation and/or other materials provided with the distribution. 13 // * Neither the name of Google Inc. nor the names of its contributors 14 // may be used to endorse or promote products derived from this software 15 // without specific prior written permission. 16 // 17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 18 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 19 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 20 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 21 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 22 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 23 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 24 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 25 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 26 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 27 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 28 29 /// \file utils/env.hpp 30 /// Querying and manipulation of environment variables. 31 /// 32 /// These utility functions wrap the system functions to manipulate the 33 /// environment in a portable way and expose their arguments and return values 34 /// in a C++-friendly manner. 35 36 #if !defined(UTILS_ENV_HPP) 37 #define UTILS_ENV_HPP 38 39 #include <map> 40 #include <string> 41 42 #include "utils/fs/path_fwd.hpp" 43 #include "utils/optional_fwd.hpp" 44 45 namespace utils { 46 47 48 std::map< std::string, std::string > getallenv(void); 49 optional< std::string > getenv(const std::string&); 50 std::string getenv_with_default(const std::string&, const std::string&); 51 optional< utils::fs::path > get_home(void); 52 void setenv(const std::string&, const std::string&); 53 void unsetenv(const std::string&); 54 55 56 } // namespace utils 57 58 #endif // !defined(UTILS_ENV_HPP) 59