color.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 <cstdint>
#include <string>
 
namespace sham::term {

    enum class ColorLevel {
        NoColor = 0,
        Basic = 1,
        ANSI256 = 2,
        TrueColor = 3,
    };

    ColorLevel color_level();

    void set_color_level(ColorLevel level);

    void enable_colors();

    void disable_colors();

    bool are_colors_enabled();

    namespace style {
        const char *reset();
        const char *bold();
        const char *faint();
        const char *underline();
        const char *blink();
    } // namespace style

    namespace colors_8b {
        const char *black();
        const char *red();
        const char *green();
        const char *yellow();
        const char *blue();
        const char *magenta();
        const char *cyan();
        const char *white();
    } // namespace colors_8b

    namespace colors_256 {
        std::string foreground(std::uint8_t index);
        std::string background(std::uint8_t index);
    } // namespace colors_256

    namespace colors_24b {
        std::string foreground(std::uint8_t r, std::uint8_t g, std::uint8_t b);
        std::string background(std::uint8_t r, std::uint8_t g, std::uint8_t b);
    } // namespace colors_24b
 
} // namespace sham::term