Shamrock/doxygen/shamterm_2include_2sham_2term_2env_8hpp_source.html

// -------------------------------------------------------//

//

// 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 "sham/term/error_callback.hpp"

#include <string_view>

#include <optional>


namespace sham::term {


    struct TermEnvVars {

        std::optional<std::string_view> TERM;

        std::optional<std::string_view> COLORTERM;

        std::optional<std::string_view> NO_COLOR;

        std::optional<std::string_view> CLICOLOR_FORCE;

        std::optional<std::string_view> COLUMN;

    };


    void parse_terminal_support(TermEnvVars vars, const term_parse_callback_t &error_callback);


} // namespace sham::term

error_callback.hpp
Shared callback type definition for parsing error handling.

sham::term::term_parse_callback_t
std::function< std::invalid_argument(const char *what, std::source_location where)> term_parse_callback_t
Callback signature for parsing error reporting (returns what, receives source location).
Definition error_callback.hpp:27

sham::term::parse_terminal_support
void parse_terminal_support(TermEnvVars vars, const term_parse_callback_t &error_callback)
Parses terminal environment variables to determine color support and set terminal size.
Definition env.cpp:73

sham::term::TermEnvVars
Holds optional terminal environment variables (TERM, COLORTERM, NO_COLOR, CLICOLOR_FORCE,...
Definition env.hpp:28