Shamrock/doxygen/term__colors_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/color.hpp"

#include <string>

namespace shambase {


    namespace term_colors {


        inline void enable_colors() { sham::term::enable_colors(); }


        inline void disable_colors() { sham::term::disable_colors(); }


        inline bool colors_enabled() { return sham::term::are_colors_enabled(); }


        inline const std::string empty() { return ""; };

        inline const std::string reset() { return sham::term::style::reset(); };

        inline const std::string bold() { return sham::term::style::bold(); };

        inline const std::string faint() { return sham::term::style::faint(); };

        inline const std::string underline() { return sham::term::style::underline(); };

        inline const std::string blink() { return sham::term::style::blink(); };

        inline const std::string col8b_black() { return sham::term::colors_8b::black(); };

        inline const std::string col8b_red() { return sham::term::colors_8b::red(); };

        inline const std::string col8b_green() { return sham::term::colors_8b::green(); };

        inline const std::string col8b_yellow() { return sham::term::colors_8b::yellow(); };

        inline const std::string col8b_blue() { return sham::term::colors_8b::blue(); };

        inline const std::string col8b_magenta() { return sham::term::colors_8b::magenta(); };

        inline const std::string col8b_cyan() { return sham::term::colors_8b::cyan(); };

        inline const std::string col8b_white() { return sham::term::colors_8b::white(); };


    } // namespace term_colors


} // namespace shambase

color.hpp
Terminal color escape sequences and enable/disable control.

sham::term::enable_colors
void enable_colors()
Enable terminal color output.
Definition color.cpp:62

sham::term::disable_colors
void disable_colors()
Disable all terminal color output.
Definition color.cpp:65

sham::term::are_colors_enabled
bool are_colors_enabled()
Query whether terminal color output is currently enabled.
Definition color.cpp:68

sham::term::colors_8b::red
const char * red()
Escape sequence to set red text color.
Definition color.cpp:52

sham::term::colors_8b::green
const char * green()
Escape sequence to set green text color.
Definition color.cpp:53

sham::term::colors_8b::black
const char * black()
Escape sequence to set black text color.
Definition color.cpp:51

sham::term::colors_8b::white
const char * white()
Escape sequence to set white text color.
Definition color.cpp:58

sham::term::colors_8b::magenta
const char * magenta()
Escape sequence to set magenta (pink) text color.
Definition color.cpp:56

sham::term::colors_8b::cyan
const char * cyan()
Escape sequence to set cyan text color.
Definition color.cpp:57

sham::term::colors_8b::blue
const char * blue()
Escape sequence to set blue text color.
Definition color.cpp:55

sham::term::colors_8b::yellow
const char * yellow()
Escape sequence to set yellow text color.
Definition color.cpp:54

sham::term::style::blink
const char * blink()
escape sequence to set blinking text formatting.
Definition color.cpp:47

sham::term::style::reset
const char * reset()
escape sequence to reset the terminal text formatting.
Definition color.cpp:43

sham::term::style::bold
const char * bold()
escape sequence to set bold text formatting.
Definition color.cpp:44

sham::term::style::underline
const char * underline()
escape sequence to set underlined text formatting.
Definition color.cpp:46

sham::term::style::faint
const char * faint()
escape sequence to set faint (dim) text formatting.
Definition color.cpp:45

shambase
namespace for basic c++ utilities
Definition sycl_builtins.hpp:25

shambase::term_colors::reset
const std::string reset()
Get the reset terminal escape char.
Definition term_colors.hpp:37

shambase::term_colors::col8b_yellow
const std::string col8b_yellow()
Get the yellow terminal escape char.
Definition term_colors.hpp:53

shambase::term_colors::col8b_white
const std::string col8b_white()
Get the white terminal escape char.
Definition term_colors.hpp:61

shambase::term_colors::col8b_magenta
const std::string col8b_magenta()
Get the magenta (pink) terminal escape char.
Definition term_colors.hpp:57

shambase::term_colors::empty
const std::string empty()
Get the empty terminal escape.
Definition term_colors.hpp:35

shambase::term_colors::blink
const std::string blink()
Get the blink terminal escape char.
Definition term_colors.hpp:45

shambase::term_colors::col8b_green
const std::string col8b_green()
Get the green terminal escape char.
Definition term_colors.hpp:51

shambase::term_colors::col8b_blue
const std::string col8b_blue()
Get the blue terminal escape char.
Definition term_colors.hpp:55

shambase::term_colors::col8b_black
const std::string col8b_black()
Get the black terminal escape char.
Definition term_colors.hpp:47

shambase::term_colors::underline
const std::string underline()
Get the underline terminal escape char.
Definition term_colors.hpp:43

shambase::term_colors::colors_enabled
bool colors_enabled()
Are colors enabled.
Definition term_colors.hpp:32

shambase::term_colors::disable_colors
void disable_colors()
Disable all colors.
Definition term_colors.hpp:29

shambase::term_colors::enable_colors
void enable_colors()
Enable colors in logs.
Definition term_colors.hpp:26

shambase::term_colors::col8b_cyan
const std::string col8b_cyan()
Get the cyan terminal escape char.
Definition term_colors.hpp:59

shambase::term_colors::faint
const std::string faint()
Get the faint terminal escape char.
Definition term_colors.hpp:41

shambase::term_colors::bold
const std::string bold()
Get the bold terminal escape char.
Definition term_colors.hpp:39

shambase::term_colors::col8b_red
const std::string col8b_red()
Get the red terminal escape char.
Definition term_colors.hpp:49