cosmos::term::FeatureBase Class Reference

Base class to build nested ANSI feature objects. More...

#include <colors.hxx>

Inheritance diagram for cosmos::term::FeatureBase:

Public Member Functions
ANSICode	getOnCode () const
ANSICode	getOffCode () const
bool	hasText () const
const std::string_view &	getText () const
bool	hasNextFeature () const
const FeatureBase &	getNextFeature () const

Protected Member Functions
	FeatureBase (const std::string_view &text, const ANSICode on_code, const ANSICode off_code)
	FeatureBase (const FeatureBase &next, const ANSICode on_code, const ANSICode off_code)

Protected Attributes
std::variant< const std::string_view *, const FeatureBase * >	m_info
	either a terminal string or a pointer to the next feature to apply.
const ANSICode	m_on_code
const ANSICode	m_off_code

Detailed Description

Base class to build nested ANSI feature objects.

Each instance of this object either holds a piece of text or a pointer to the next feature to be applied. Each object at this level only knows the ANSI codes to enable and disable the feature it represents.

The output operator thus can apply all desired features for the piece of text and restore the original terminal features after the output is finished.

This allows nested features like std::cout << Green(OnBlue("my green on //blue text")) << "\n";

Definition at line 165 of file colors.hxx.

Constructor & Destructor Documentation

FeatureBase() [1/2]

cosmos::term::FeatureBase::FeatureBase ( const std::string_view & text, const ANSICode on_code, const ANSICode off_code )

inlineprotected

Definition at line 174 of file colors.hxx.

                                                                                                 :
                m_info(&text), m_on_code(on_code), m_off_code(off_code)
        {}

FeatureBase() [2/2]

cosmos::term::FeatureBase::FeatureBase ( const FeatureBase & next, const ANSICode on_code, const ANSICode off_code )

inlineprotected

Definition at line 178 of file colors.hxx.

                                                                                              :
                m_info(&next), m_on_code(on_code), m_off_code(off_code)
        {}

Member Function Documentation

getNextFeature()

const FeatureBase & cosmos::term::FeatureBase::getNextFeature ( ) const

inline

Definition at line 172 of file colors.hxx.

{ return *std::get<const FeatureBase*>(m_info); }

getOffCode()

ANSICode cosmos::term::FeatureBase::getOffCode ( ) const

inline

Definition at line 168 of file colors.hxx.

{ return m_off_code; }

getOnCode()

ANSICode cosmos::term::FeatureBase::getOnCode ( ) const

inline

Definition at line 167 of file colors.hxx.

{ return m_on_code; }

getText()

const std::string_view & cosmos::term::FeatureBase::getText ( ) const

inline

Definition at line 170 of file colors.hxx.

{ return *std::get<const std::string_view*>(m_info); }

hasNextFeature()

bool cosmos::term::FeatureBase::hasNextFeature ( ) const

inline

Definition at line 171 of file colors.hxx.

{ return std::holds_alternative<const FeatureBase*>(m_info); }

hasText()

bool cosmos::term::FeatureBase::hasText ( ) const

inline

Definition at line 169 of file colors.hxx.

{ return std::holds_alternative<const std::string_view*>(m_info); }

Member Data Documentation

m_info

std::variant<const std::string_view*, const FeatureBase*> cosmos::term::FeatureBase::m_info

protected

either a terminal string or a pointer to the next feature to apply.

Definition at line 187 of file colors.hxx.

m_off_code

const ANSICode cosmos::term::FeatureBase::m_off_code

protected

Definition at line 189 of file colors.hxx.

m_on_code

const ANSICode cosmos::term::FeatureBase::m_on_code

protected

Definition at line 188 of file colors.hxx.

---

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

• include/io/colors.hxx