env.hpp

Go to the documentation of this file.

// -------------------------------------------------------//
//
// SHAMROCK code for hydrodynamics
// Copyright (c) 2021-2026 Timothée David--Cléris <tim.shamrock@proton.me>
// SPDX-License-Identifier: CeCILL Free Software License Agreement v2.1
// Shamrock is licensed under the CeCILL 2.1 License, see LICENSE for more information
//
// -------------------------------------------------------//
 
#pragma once

 
#include <optional>
#include <string>
 
namespace shamcmdopt {

    std::optional<std::string> getenv_str(const char *env_var);

    std::optional<std::string_view> getenv_str_view(const char *env_var);

    inline std::string getenv_str_default(const char *env_var, std::string default_val) {
        auto val = getenv_str(env_var);
        return val ? *val : default_val;
    }

    void register_env_var_doc(std::string env_var, std::string desc);

    inline std::optional<std::string> getenv_str_register(const char *env_var, std::string desc) {
        register_env_var_doc(env_var, desc);
        return getenv_str(env_var);
    }

    inline std::string getenv_str_default_register(
        const char *env_var, std::string default_val, std::string desc) {
        register_env_var_doc(env_var, desc);
        return getenv_str_default(env_var, default_val);
    }

    void print_help_env_var();
 
} // namespace shamcmdopt