1 // 2 // Copyright 2016 Pixar 3 // 4 // Licensed under the Apache License, Version 2.0 (the "Apache License") 5 // with the following modification; you may not use this file except in 6 // compliance with the Apache License and the following modification to it: 7 // Section 6. Trademarks. is deleted and replaced with: 8 // 9 // 6. Trademarks. This License does not grant permission to use the trade 10 // names, trademarks, service marks, or product names of the Licensor 11 // and its affiliates, except as required to comply with Section 4(c) of 12 // the License and to reproduce the content of the NOTICE file. 13 // 14 // You may obtain a copy of the Apache License at 15 // 16 // http://www.apache.org/licenses/LICENSE-2.0 17 // 18 // Unless required by applicable law or agreed to in writing, software 19 // distributed under the Apache License with the above modification is 20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 21 // KIND, either express or implied. See the Apache License for the specific 22 // language governing permissions and limitations under the Apache License. 23 // 24 #ifndef PXR_BASE_TF_GETENV_H 25 #define PXR_BASE_TF_GETENV_H 26 27 /// \file tf/getenv.h 28 /// \ingroup group_tf_SystemsExt 29 /// Functions for accessing environment variables. 30 31 #include "pxr/pxr.h" 32 #include "pxr/base/tf/api.h" 33 34 #include <string> 35 36 PXR_NAMESPACE_OPEN_SCOPE 37 38 /// \addtogroup group_tf_SystemsExt 39 ///@{ 40 41 /// Return an environment variable as a string. 42 /// 43 /// Return the value of the environment variable \c envName 44 /// as a string. If the variable is unset, or is the empty string, 45 /// then \c defaultValue is returned. 46 TF_API 47 std::string TfGetenv(const std::string& envName, 48 const std::string& defaultValue = ""); 49 50 /// Return an environment variable as an integer. 51 /// 52 /// Return the value of the environment variable \c envName as an integer. If 53 /// the variable is unset, or is the empty string, then \c defaultValue is 54 /// returned. Otherwise, the function uses atoi() to convert the string to an 55 /// integer: the implication being that if the string is not a valid integer, 56 /// you get back whatever value atoi() comes up with. 57 TF_API 58 int TfGetenvInt(const std::string& envName, int defaultValue); 59 60 /// Return an environment variable as a boolean. 61 /// 62 /// Return the value of the environment variable \c envName as a boolean. If 63 /// the variable is unset, or is the empty string, then \c defaultValue is 64 /// returned. A value of \c true is returned if the environment variable is 65 /// any of "true", "yes", "on" or "1"; the match is not case sensitive. All 66 /// other values yield a return value of \c false. 67 TF_API 68 bool TfGetenvBool(const std::string&, bool defaultValue); 69 70 /// Return an environment variable as a double. 71 /// 72 /// Return the value of the environment variable \c envName as a double. If 73 /// the variable is unset, or is the empty string, then \c defaultValue is 74 /// returned. Otherwise, the function uses TfStringToDouble() to convert the 75 /// string to a double: the implication being that if the string is not a 76 /// valid double, you get back whatever value TfStringToDouble() comes up 77 /// with. 78 TF_API 79 double TfGetenvDouble(const std::string& envName, double defaultValue); 80 81 ///@} 82 83 PXR_NAMESPACE_CLOSE_SCOPE 84 85 #endif 86