colour_string::ColourString Class Reference

Simple addition of colour to strings and ostreams. More...

#include <vic_strings.hpp>

Collaboration diagram for colour_string::ColourString:

Public Member Functions
	ColourString (bool uc)
bool	get_use_colours () const
void	set_use_colours (bool b)
void	set_map (uint8_t i, ColourName colour)
ColourString	operator() (const string &_s)
string	operator() (const string &_s, size_t num)
string	red ()
string	green ()
string	blue ()
string	lblue ()
string	orange ()
string	yellow ()
string	purple ()
string	grey ()
string	lgrey ()

Private Attributes
uint8_t	num_colours
bool	use_colours
std::vector< ColourName >	map
string	s

Detailed Description

Simple addition of colour to strings and ostreams.

The format is:

cout << col("Hello").red() ...;

Also incorporates a map allowing the format:

col.set_map(2, ColourName::PURPLE); cout << col("Hello", 2) << ...

so that assignment of colours can easily be changed

Definition at line 121 of file vic_strings.hpp.

Constructor & Destructor Documentation

ColourString()

colour_string::ColourString::ColourString ( bool uc )

inline

Definition at line 128 of file vic_strings.hpp.

      : num_colours(Colour::num_colours)
      , use_colours(uc)
      , map()
      , s()
    {
      map = { ColourName::NOCOL,
          ColourName::RED,
          ColourName::GREEN,
          ColourName::BLUE,
          ColourName::LBLUE,
          ColourName::ORANGE,
          ColourName::YELLOW,
          ColourName::PURPLE,
          ColourName::GREY,
          ColourName::LGREY };
    }

Member Function Documentation

blue()

string colour_string::ColourString::blue ( )

inline

Definition at line 189 of file vic_strings.hpp.

                    {
      if (use_colours)
        return Colour::blue + s + Colour::nocol;
       else
          return s;
    }

get_use_colours()

bool colour_string::ColourString::get_use_colours ( ) const

inline

Definition at line 148 of file vic_strings.hpp.

{ return use_colours; }

green()

string colour_string::ColourString::green ( )

inline

Definition at line 183 of file vic_strings.hpp.

                    {
      if (use_colours)
         return Colour::green + s + Colour::nocol;
      else
         return s;
    }

grey()

string colour_string::ColourString::grey ( )

inline

Definition at line 219 of file vic_strings.hpp.

                    {
      if (use_colours)
          return Colour::grey + s + Colour::nocol;
      else
          return s;
    }

lblue()

string colour_string::ColourString::lblue ( )

inline

Definition at line 195 of file vic_strings.hpp.

                    {
      if (use_colours)
          return Colour::lblue + s + Colour::nocol;
      else
        return s;
    }

lgrey()

string colour_string::ColourString::lgrey ( )

inline

Definition at line 225 of file vic_strings.hpp.

                    {
      if (use_colours)
          return Colour::lgrey + s + Colour::nocol;
      else
          return s;
    }

operator()() [1/2]

ColourString colour_string::ColourString::operator() ( const string & _s )

inline

This sets the member string. The idea is to allow other methods to add the colour to it.

Definition at line 158 of file vic_strings.hpp.

                                              {
      s = _s;
      return *this;
    }

operator()() [2/2]

string colour_string::ColourString::operator() ( const string & _s, size_t num )

inline

Make a coloured string using the map.

Does not affect the stored string.

Definition at line 167 of file vic_strings.hpp.

                                                    {
      if (use_colours && num >=0 && num < map.size())
         return Colour::name_to_string(map[num]) + _s + Colour::nocol;
      else
         return _s;
    }

orange()

string colour_string::ColourString::orange ( )

inline

Definition at line 201 of file vic_strings.hpp.

                    {
      if (use_colours)
          return Colour::orange + s + Colour::nocol;
      else
          return s;
    }

purple()

string colour_string::ColourString::purple ( )

inline

Definition at line 213 of file vic_strings.hpp.

                    {
      if (use_colours)
          return Colour::purple + s + Colour::nocol;
      else
          return s;
    }

red()

string colour_string::ColourString::red ( )

inline

Definition at line 177 of file vic_strings.hpp.

                    {
      if (use_colours)
         return Colour::red + s + Colour::nocol;
      else
        return s;
    }

set_map()

void colour_string::ColourString::set_map ( uint8_t i, ColourName colour )

inline

Definition at line 150 of file vic_strings.hpp.

                                               {
      if (i >= 0 && i < Colour::num_colours)
        map[i] = colour;
    }

set_use_colours()

void colour_string::ColourString::set_use_colours ( bool b )

inline

Definition at line 149 of file vic_strings.hpp.

{ use_colours = b; }

yellow()

string colour_string::ColourString::yellow ( )

inline

Definition at line 207 of file vic_strings.hpp.

                    {
      if (use_colours)
          return Colour::yellow + s + Colour::nocol;
      else
          return s;
    }

Member Data Documentation

map

std::vector<ColourName> colour_string::ColourString::map

private

Definition at line 125 of file vic_strings.hpp.

num_colours

uint8_t colour_string::ColourString::num_colours

private

Definition at line 123 of file vic_strings.hpp.

s

string colour_string::ColourString::s

private

Definition at line 126 of file vic_strings.hpp.

use_colours

bool colour_string::ColourString::use_colours

private

Definition at line 124 of file vic_strings.hpp.

---

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

• /Users/sbh11/Desktop/connection-prover/c++/connect++/source/utilities/vic_strings.hpp