gz/utils/Environment.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2021 Open Source Robotics Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */
 
#ifndef GZ_UTILS_ENVIRONMENT_HH_
#define GZ_UTILS_ENVIRONMENT_HH_
 
#include <gz/utils/config.hh>
#include <gz/utils/Export.hh>
 
#include <string>
#include <unordered_map>
#include <vector>
 
namespace gz
{
namespace utils
{
inline namespace GZ_UTILS_VERSION_NAMESPACE {
 
bool GZ_UTILS_VISIBLE env(
    const std::string &_name, std::string &_value,
    bool _allowEmpty = false);
 
//
bool GZ_UTILS_VISIBLE setenv(
    const std::string &_name, const std::string &_value);
 
bool GZ_UTILS_VISIBLE unsetenv(const std::string &_name);
 
bool GZ_UTILS_VISIBLE clearenv();
 
using EnvironmentMap = std::unordered_map<std::string, std::string>;
 
using EnvironmentStrings = std::vector<std::string>;
 
EnvironmentMap GZ_UTILS_VISIBLE envStringsToMap(
  const EnvironmentStrings &_envStrings);
 
EnvironmentStrings GZ_UTILS_VISIBLE envMapToStrings(
  const EnvironmentMap &_envMap);
 
EnvironmentMap GZ_UTILS_VISIBLE env();
 
//
bool GZ_UTILS_VISIBLE setenv(const EnvironmentMap &_vars);
 
std::string GZ_UTILS_VISIBLE printenv();
}  // namespace GZ_UTILS_VERSION_NAMESPACE
}  // namespace utils
}  // namespace gz
 
#endif  // GZ_UTILS_ENVIRONMENT_HH_