/******************************************************************************* * * MIT License * * Copyright (c) 2017 Advanced Micro Devices, Inc. * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in all * copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. * *******************************************************************************/ #ifndef GUARD_OLC_ENV_HPP #define GUARD_OLC_ENV_HPP #include #include #include #include namespace online_compile { /// \todo Rework: Case-insensitive string compare, ODR, (?) move to .cpp // Declare a cached environment variable #define OLC_DECLARE_ENV_VAR(x) \ struct x \ { \ static const char* value() { return #x; } \ }; /* * Returns false if a feature-controlling environment variable is defined * and set to something which disables a feature. */ inline bool IsEnvvarValueDisabled(const char* name) { const auto value_env_p = std::getenv(name); return value_env_p != nullptr && (std::strcmp(value_env_p, "disable") == 0 || std::strcmp(value_env_p, "disabled") == 0 || std::strcmp(value_env_p, "0") == 0 || std::strcmp(value_env_p, "no") == 0 || std::strcmp(value_env_p, "false") == 0); } inline bool IsEnvvarValueEnabled(const char* name) { const auto value_env_p = std::getenv(name); return value_env_p != nullptr && (std::strcmp(value_env_p, "enable") == 0 || std::strcmp(value_env_p, "enabled") == 0 || std::strcmp(value_env_p, "1") == 0 || std::strcmp(value_env_p, "yes") == 0 || std::strcmp(value_env_p, "true") == 0); } // Return 0 if env is enabled else convert environment var to an int. // Supports hexadecimal with leading 0x or decimal inline unsigned long int EnvvarValue(const char* name, unsigned long int fallback = 0) { const auto value_env_p = std::getenv(name); if(value_env_p == nullptr) { return fallback; } else { return strtoul(value_env_p, nullptr, 0); } } inline std::vector GetEnv(const char* name) { const auto p = std::getenv(name); if(p == nullptr) return {}; else return {{p}}; } template inline const char* GetStringEnv(T) { static const std::vector result = GetEnv(T::value()); if(result.empty()) return nullptr; else return result.front().c_str(); } template inline bool IsEnabled(T) { static const bool result = online_compile::IsEnvvarValueEnabled(T::value()); return result; } template inline bool IsDisabled(T) { static const bool result = online_compile::IsEnvvarValueDisabled(T::value()); return result; } template inline unsigned long int Value(T, unsigned long int fallback = 0) { static const auto result = online_compile::EnvvarValue(T::value(), fallback); return result; } } // namespace online_compile #endif