cmdopt.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 <string_view>
#include <optional>
#include <stdexcept>
#include <string>
#include <vector>
 
namespace shamcmdopt {
 
    int get_argc();
 
    char **get_argv();
 
    void register_opt(std::string name, std::optional<std::string> args, std::string description);
 
    void init(int argc, char *argv[]);
 
    bool has_option(const std::string_view &option_name);
 
    std::string_view get_option(const std::string_view &option_name);
 
    void print_help();
 
    void print_completion_zsh();
 
    bool is_help_mode();
 
} // namespace shamcmdopt
 
namespace opts {
    using namespace shamcmdopt;
}