color.hpp

Go to the documentation of this file.

/*
* cpp-terminal
* C++ library for writing multi-platform terminal applications.
*
* SPDX-FileCopyrightText: 2019-2024 cpp-terminal
*
* SPDX-License-Identifier: MIT
*/
 
#pragma once
 
#include "cpp-terminal/terminfo.hpp"
 
#include <array>
#include <cstdint>
#include <string>
 
namespace Term
{
 
class Color
{
public:
  enum class Type : std::uint8_t
  {
    Unset,
    NoColor,
    Bit3,
    Bit4,
    Bit8,
    Bit24
  };
 
  enum class Name : std::uint8_t
  {
    Black         = 0,   
    Red           = 1,   
    Green         = 2,   
    Yellow        = 3,   
    Blue          = 4,   
    Magenta       = 5,   
    Cyan          = 6,   
    White         = 7,   
    Default       = 9,   
    Gray          = 60,  
    BrightBlack   = 60,  
    BrightRed     = 61,  
    BrightGreen   = 62,  
    BrightYellow  = 63,  
    BrightBlue    = 64,  
    BrightMagenta = 65,  
    BrightCyan    = 66,  
    BrightWhite   = 67   
  };
  bool operator==(const Color&) const;
  bool operator!=(const Color&) const;
  Color();
  Color(const Term::Color::Name& name);
  Color(const std::uint8_t& color);
  Color(const std::uint8_t& red, const std::uint8_t& green, const std::uint8_t& blue);
  Type                        getType() const;
  Name                        to3bits() const;
  Name                        to4bits() const;
  std::uint8_t                to8bits() const;
  std::array<std::uint8_t, 3> to24bits() const;
 
private:
  Type m_Type{Type::Unset};
  union
  {
    std::uint8_t                m_bit8;
    std::array<std::uint8_t, 3> m_bit24;
  };
};
 
std::string color_bg(const Term::Color::Name& name);
std::string color_bg(const std::uint8_t& value);
std::string color_bg(const std::uint8_t& red, const std::uint8_t& green, const std::uint8_t& blue);
std::string color_bg(const Color& color);
 
std::string color_fg(const Term::Color::Name& name);
std::string color_fg(const std::uint8_t& value);
std::string color_fg(const std::uint8_t& red, const std::uint8_t& green, const std::uint8_t& blue);
std::string color_fg(const Color& color);
 
}  // namespace Term