#include <cpp-terminal/terminfo.hpp>

Public Types
enum class	ColorMode : std::uint8_t { Unset , NoColor , Bit3 , Bit4 , Bit8 , Bit24 }

enum class	Bool : std::uint8_t { UTF8 = 0 , Legacy , ControlSequences }

enum class	String : std::uint8_t { TermEnv , TermName , TermVersion }

enum class	Integer : std::uint8_t

using	Booleans = std::array<bool, BoolNumber>

using	Strings = std::array<std::string, StringNumber>

using	Integers = std::array<std::uint32_t, IntegerNumber>

Public Member Functions
	Terminfo ()

Static Public Member Functions
static bool	get (const Term::Terminfo::Bool &key)

static std::uint32_t	get (const Term::Terminfo::Integer &key)

static std::string	get (const Term::Terminfo::String &key)

static ColorMode	getColorMode ()

Static Private Member Functions
static void	check ()

static void	checkTermEnv ()

static void	checkTerminalName ()

static void	checkTerminalVersion ()

static void	checkColorMode ()

static void	checkUTF8 ()

static void	checkLegacy ()

static void	checkControlSequences ()

static void	set (const Term::Terminfo::Bool &key, const bool &value)

static void	set (const Term::Terminfo::Integer &key, const std::uint32_t &value)

static void	set (const Term::Terminfo::String &key, const std::string &value)

Static Private Attributes
static const constexpr std::size_t	BoolNumber {3}

static const constexpr std::size_t	StringNumber {3}

static const constexpr std::size_t	IntegerNumber {0}

static ColorMode	m_colorMode {ColorMode::Unset}

static Booleans	m_booleans {}

static Integers	m_integers {}

static Strings	m_strings {}

Detailed Description

Definition at line 19 of file terminfo.hpp.

Member Typedef Documentation

◆ Booleans

using Term::Terminfo::Booleans = std::array<bool, BoolNumber>

Definition at line 65 of file terminfo.hpp.

◆ Integers

using Term::Terminfo::Integers = std::array<std::uint32_t, IntegerNumber>

Definition at line 67 of file terminfo.hpp.

◆ Strings

using Term::Terminfo::Strings = std::array<std::string, StringNumber>

Definition at line 66 of file terminfo.hpp.

Member Enumeration Documentation

◆ Bool

enum class Term::Terminfo::Bool : std::uint8_t

strong

Enumerator
UTF8	terminal has UTF-8 activated.
Legacy	Terminal is in legacy mode (Windows only).
ControlSequences	Terminal support control sequences.

Definition at line 38 of file terminfo.hpp.

  {
    UTF8 = 0,          
    Legacy,            
    ControlSequences,  
  };

◆ ColorMode

enum class Term::Terminfo::ColorMode : std::uint8_t

strong

Enumerator
Unset
NoColor
Bit3
Bit4
Bit8
Bit24

Definition at line 24 of file terminfo.hpp.

  {
    Unset,
    // no color was used
    NoColor,
    // a 3bit color was used
    Bit3,
    // a 4bit color was used
    Bit4,
    // a 8bit color was used
    Bit8,
    // a 24bit (RGB) color was used
    Bit24
  };

◆ Integer

enum class Term::Terminfo::Integer : std::uint8_t

strong

Definition at line 50 of file terminfo.hpp.

  {
 
  };

◆ String

enum class Term::Terminfo::String : std::uint8_t

strong

Enumerator
TermEnv	TERM environment variable value.
TermName	Name of the terminal program if available.
TermVersion	Terminal version.

Definition at line 44 of file terminfo.hpp.

  {
    TermEnv,      
    TermName,     
    TermVersion,  
  };

Constructor & Destructor Documentation

◆ Terminfo()

Term::Terminfo::Terminfo ( )

Definition at line 142 of file terminfo.cpp.

142{ check(); }

Term::Terminfo::check

static void check()

Definition terminfo.cpp:120

Member Function Documentation

◆ check()

void Term::Terminfo::check ( )

staticprivate

Definition at line 120 of file terminfo.cpp.

{
  static bool checked{false};
  if(!checked)
  {
    checkTermEnv();
    checkTerminalName();
    checkTerminalVersion();
    checkControlSequences();
    checkLegacy();
    checkColorMode();
    checkUTF8();
    checked = true;
  }
}

◆ checkColorMode()

void Term::Terminfo::checkColorMode ( )

staticprivate

Definition at line 144 of file terminfo.cpp.

{
  std::string name{m_strings[static_cast<std::size_t>(Terminfo::String::TermName)]};
  if(name == "Apple_Terminal") { m_colorMode = Term::Terminfo::ColorMode::Bit8; }
  else if(name == "JetBrains-JediTerm") { m_colorMode = Term::Terminfo::ColorMode::Bit24; }
  else if(name == "vscode") { m_colorMode = Term::Terminfo::ColorMode::Bit24; }
  else if(name == "linux") { m_colorMode = Term::Terminfo::ColorMode::Bit4; }
  else if(name == "ansicon") { m_colorMode = Term::Terminfo::ColorMode::Bit4; }
  else if(m_strings[static_cast<std::size_t>(Terminfo::String::TermEnv)] == "linux") { m_colorMode = Term::Terminfo::ColorMode::Bit4; }
#if defined(_WIN32)
  else if(WindowsVersionGreater(10, 0, 10586) && !m_booleans[static_cast<std::size_t>(Terminfo::Bool::Legacy)]) { m_colorMode = Term::Terminfo::ColorMode::Bit24; }
  else if(m_booleans[static_cast<std::size_t>(Terminfo::Bool::Legacy)]) { m_colorMode = Term::Terminfo::ColorMode::Bit4; }
#endif
  else { m_colorMode = Term::Terminfo::ColorMode::Bit24; }
  std::string colorterm = Private::getenv("COLORTERM").second;
  if((colorterm == "truecolor" || colorterm == "24bit") && m_colorMode != ColorMode::Unset) { m_colorMode = Term::Terminfo::ColorMode::Bit24; }
}

◆ checkControlSequences()

void Term::Terminfo::checkControlSequences ( )

staticprivate

Definition at line 162 of file terminfo.cpp.

{
#ifdef _WIN32
  if(WindowsVersionGreater(10, 0, 10586)) { set(Term::Terminfo::Bool::ControlSequences, true); }
  else { set(Term::Terminfo::Bool::ControlSequences, false); }
#else
  set(Term::Terminfo::Bool::ControlSequences, true);
#endif
}

◆ checkLegacy()

void Term::Terminfo::checkLegacy ( )

staticprivate

Definition at line 84 of file terminfo.cpp.

{
#if defined(_WIN32)
  #ifndef ENABLE_VIRTUAL_TERMINAL_PROCESSING
    #define ENABLE_VIRTUAL_TERMINAL_PROCESSING 0x0004
  #endif
  if(!m_booleans[static_cast<std::size_t>(Terminfo::Bool::ControlSequences)]) { set(Terminfo::Bool::Legacy, true); }
  else
  {
    DWORD dwOriginalOutMode{0};
    GetConsoleMode(Private::out.handle(), &dwOriginalOutMode);
    if(!SetConsoleMode(Private::out.handle(), dwOriginalOutMode | ENABLE_VIRTUAL_TERMINAL_PROCESSING)) { set(Terminfo::Bool::Legacy, true); }
    else
    {
      SetConsoleMode(Private::out.handle(), dwOriginalOutMode);
      set(Terminfo::Bool::Legacy, false);
    }
  }
#else
  set(Terminfo::Bool::Legacy, false);
#endif
}

◆ checkTermEnv()

void Term::Terminfo::checkTermEnv ( )

staticprivate

Definition at line 107 of file terminfo.cpp.

107{ set(Terminfo::String::TermEnv, Private::getenv("TERM").second); }

◆ checkTerminalName()

void Term::Terminfo::checkTerminalName ( )

staticprivate

Definition at line 109 of file terminfo.cpp.

{
  std::string name;
  name = Private::getenv("TERM_PROGRAM").second;
  if(name.empty()) { name = Private::getenv("TERMINAL_EMULATOR").second; }
  if(Private::getenv("ANSICON").first) { name = "ansicon"; }
  set(Term::Terminfo::String::TermName, name);
}

◆ checkTerminalVersion()

void Term::Terminfo::checkTerminalVersion ( )

staticprivate

Definition at line 118 of file terminfo.cpp.

118{ set(Terminfo::String::TermVersion, Private::getenv("TERM_PROGRAM_VERSION").second); }

Term::Terminfo::String::TermVersion

@ TermVersion

Terminal version.

Definition terminfo.hpp:48

◆ checkUTF8()

void Term::Terminfo::checkUTF8 ( )

staticprivate

Definition at line 172 of file terminfo.cpp.

{
#if defined(_WIN32)
  (GetConsoleOutputCP() == CP_UTF8 && GetConsoleCP() == CP_UTF8) ? set(Terminfo::Bool::UTF8, true) : set(Terminfo::Bool::UTF8, false);
#else
  Term::Cursor cursor_before{Term::cursor_position()};
  Term::Private::out.write("\xe2\x82\xac");  // € 3bits in utf8 one character
  std::string  read{Term::Private::in.read()};
  Term::Cursor cursor_after{Term::cursor_position()};
  std::size_t  moved{cursor_after.column() - cursor_before.column()};
  if(moved == 1) { set(Terminfo::Bool::UTF8, true); }
  else { set(Terminfo::Bool::UTF8, false); }
  for(std::size_t i = 0; i != moved; ++i) { Term::Private::out.write("\b \b"); }
#endif
}

◆ get() [1/3]

bool Term::Terminfo::get ( const Term::Terminfo::Bool & key )

static

Definition at line 30 of file terminfo.cpp.

{
  check();
  return m_booleans[static_cast<std::size_t>(key)];
}

◆ get() [2/3]

std::uint32_t Term::Terminfo::get ( const Term::Terminfo::Integer & key )

static

Definition at line 36 of file terminfo.cpp.

{
  check();
  return m_integers[static_cast<std::size_t>(key)];
}

◆ get() [3/3]

std::string Term::Terminfo::get ( const Term::Terminfo::String & key )

static

Definition at line 42 of file terminfo.cpp.

{
  check();
  return m_strings[static_cast<std::size_t>(key)];
}

◆ getColorMode()

Term::Terminfo::ColorMode Term::Terminfo::getColorMode ( )

static

Definition at line 136 of file terminfo.cpp.

{
  checkColorMode();
  return m_colorMode;
}

◆ set() [1/3]

void Term::Terminfo::set	(	const Term::Terminfo::Bool &	key,
		const bool &	value )

staticprivate

Definition at line 48 of file terminfo.cpp.

48{ m_booleans[static_cast<std::size_t>(key)] = value; }

◆ set() [2/3]

void Term::Terminfo::set	(	const Term::Terminfo::Integer &	key,
		const std::uint32_t &	value )

staticprivate

Definition at line 49 of file terminfo.cpp.

49{ m_integers[static_cast<std::size_t>(key)] = value; }

◆ set() [3/3]

void Term::Terminfo::set	(	const Term::Terminfo::String &	key,
		const std::string &	value )

staticprivate

Definition at line 50 of file terminfo.cpp.

50{ m_strings[static_cast<std::size_t>(key)] = value; }

Member Data Documentation

◆ BoolNumber

const constexpr std::size_t Term::Terminfo::BoolNumber {3}

staticconstexprprivate

Definition at line 60 of file terminfo.hpp.

60{3};

◆ IntegerNumber

const constexpr std::size_t Term::Terminfo::IntegerNumber {0}

staticconstexprprivate

Definition at line 62 of file terminfo.hpp.

62{0};

◆ m_booleans

Term::Terminfo::Booleans Term::Terminfo::m_booleans {}

staticprivate

Definition at line 26 of file terminfo.hpp.

◆ m_colorMode

Term::Terminfo::ColorMode Term::Terminfo::m_colorMode {ColorMode::Unset}

staticprivate

Definition at line 25 of file terminfo.hpp.

25{

◆ m_integers

Term::Terminfo::Integers Term::Terminfo::m_integers {}

staticprivate

Definition at line 27 of file terminfo.hpp.

◆ m_strings

Term::Terminfo::Strings Term::Terminfo::m_strings {}

staticprivate

Definition at line 28 of file terminfo.hpp.

◆ StringNumber

const constexpr std::size_t Term::Terminfo::StringNumber {3}

staticconstexprprivate

Definition at line 61 of file terminfo.hpp.

61{3};

The documentation for this class was generated from the following files:

cpp-terminal/terminfo.hpp
cpp-terminal/private/terminfo.cpp

Public Types

Public Member Functions

Static Public Member Functions

Static Private Member Functions

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ Booleans

◆ Integers

◆ Strings

Member Enumeration Documentation

◆ Bool

◆ ColorMode

◆ Integer

◆ String

Constructor & Destructor Documentation

◆ Terminfo()

Member Function Documentation

◆ check()

◆ checkColorMode()

◆ checkControlSequences()

◆ checkLegacy()

◆ checkTermEnv()

◆ checkTerminalName()

◆ checkTerminalVersion()

◆ checkUTF8()

◆ get() [1/3]

◆ get() [2/3]

◆ get() [3/3]

◆ getColorMode()

◆ set() [1/3]

◆ set() [2/3]

◆ set() [3/3]

Member Data Documentation

◆ BoolNumber

◆ IntegerNumber

◆ m_booleans

◆ m_colorMode

◆ m_integers

◆ m_strings

◆ StringNumber