style.cpp

Go to the documentation of this file.

/*
    Genesis - A toolkit for working with phylogenetic data.
    Copyright (C) 2014-2019 Lucas Czech and HITS gGmbH

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.

    Contact:
    Lucas Czech <lucas.czech@h-its.org>
    Exelixis Lab, Heidelberg Institute for Theoretical Studies
    Schloss-Wolfsbrunnenweg 35, D-69118 Heidelberg, Germany
*/

#include "genesis/utils/text/style.hpp"

#include "genesis/utils/text/string.hpp"

#include <algorithm>
#include <cassert>
#include <ostream>
#include <stdexcept>
#include <vector>

namespace genesis {
namespace utils {

// =================================================================================================
//     Local Helper Functions
// =================================================================================================

static std::array<std::pair<std::string, std::string>, 17>::const_iterator get_foreground_color_iterator(
    std::string name
) {
    name = replace_all(name, " ", "");
    name = replace_all(name, "_", "");

    return std::find_if(
        Style::foreground_colors.begin(),
        Style::foreground_colors.end(),
        [&name] ( std::pair<std::string, std::string> const& elem ) {
            return equals_ci( elem.first, name );
        }
    );
}

static std::array<std::pair<std::string, std::string>, 17>::const_iterator get_background_color_iterator(
    std::string name
) {
    name = replace_all(name, " ", "");
    name = replace_all(name, "_", "");

    return std::find_if(
        Style::background_colors.begin(),
        Style::background_colors.end(),
        [&name] ( std::pair<std::string, std::string> const& elem ) {
            return equals_ci( elem.first, name );
        }
    );
}

// =================================================================================================
//     Properties
// =================================================================================================

Style& Style::reset()
{
    foreground_ = "";
    background_ = "";
    bold_ = false;

    return *this;
}

bool Style::enabled() const
{
    return enabled_;
}

Style& Style::enabled( bool value )
{
    enabled_ = value;
    return *this;
}

bool Style::bold() const
{
    return bold_;
}

Style& Style::bold( bool value )
{
    bold_ = value;
    return *this;
}

std::string Style::foreground_color() const
{
    if( foreground_ == "" ) {
        return "";
    }

    auto it = get_foreground_color_iterator(foreground_);
    assert( it != Style::foreground_colors.end() );
    return it->first;
}

Style& Style::foreground_color( std::string const& color )
{
    // Check if valid color, throw if not.
    if( color != "" ) {
        get_foreground_color_value( color );
    }

    foreground_ = color;
    return *this;
}

std::string Style::background_color() const
{
    if( background_ == "" ) {
        return "";
    }

    auto it = get_background_color_iterator(background_);
    assert( it != Style::background_colors.end() );
    return it->first;
}

Style& Style::background_color( std::string const& color )
{
    // Check if valid color, throw if not.
    if( color != "" ) {
        get_background_color_value( color );
    }

    background_ = color;
    return *this;
}

// =================================================================================================
//     Output
// =================================================================================================

static std::string get_attribute_string_( Style const& s)
{
    if( ! s.enabled() ) {
        return "";
    }

    std::vector<std::string> attribs;

    if( s.bold() ) {
        attribs.push_back( "1" );
    }
    if( s.foreground_color() != "" ) {
        attribs.push_back( s.get_foreground_color_value( s.foreground_color() ));
    }
    if( s.background_color() != "" ) {
        attribs.push_back( s.get_background_color_value( s.background_color() ));
    }

    return join( attribs, ";" );
}

std::string Style::operator() ( std::string const& text ) const
{
    return to_bash_string( text );
}

std::string Style::to_bash_string( std::string const& text ) const
{
    // return "\e[" + get_attribute_string_(*this) + "m" + text_ + "\e[0m";

    auto attribs = get_attribute_string_(*this);
    if( attribs.size() > 0 ) {
        return "\033[" + get_attribute_string_(*this) + "m" + text + "\033[0m";
    } else {
        return text;
    }
}

std::string Style::to_python_string( std::string const& text ) const
{
    auto attribs = get_attribute_string_(*this);
    if( attribs.size() > 0 ) {
        return "\x1b[" + get_attribute_string_(*this) + "m" + text + "\x1b[0m";
    } else {
        return text;
    }
}

// =================================================================================================
//     Style Data
// =================================================================================================

// -------------------------------------------------------------------
//     Foreground Color
// -------------------------------------------------------------------

bool Style::is_foreground_color( std::string name )
{
    return get_foreground_color_iterator(name) != Style::foreground_colors.end();
}

std::string Style::get_foreground_color_value( std::string name )
{
    auto it = get_foreground_color_iterator(name);

    if( it == Style::foreground_colors.end() ) {
        throw std::out_of_range("No foreground color named " + name + ".");
    }
    return it->second;
}

const std::array<std::pair<std::string, std::string>, 17> Style::foreground_colors = {{
    { "Default", "39" },
    { "Black", "30" },
    { "Red", "31" },
    { "Green", "32" },
    { "Yellow", "33" },
    { "Blue", "34" },
    { "Magenta", "35" },
    { "Cyan", "36" },
    { "LightGray", "37" },
    { "DarkGray", "90" },
    { "LightRed", "91" },
    { "LightGreen", "92" },
    { "LightYellow", "93" },
    { "LightBlue", "94" },
    { "LightMagenta", "95" },
    { "LightCyan", "96" },
    { "White", "97" }
}};

// -------------------------------------------------------------------
//     Background Color
// -------------------------------------------------------------------

bool Style::is_background_color( std::string name )
{
    return get_background_color_iterator(name) != Style::background_colors.end();
}

std::string Style::get_background_color_value( std::string name )
{
    auto it = get_background_color_iterator(name);

    if( it == Style::background_colors.end() ) {
        throw std::out_of_range("No background color named " + name + ".");
    }
    return it->second;
}

const std::array<std::pair<std::string, std::string>, 17> Style::background_colors = {{
    { "Default", "49" },
    { "Black", "40" },
    { "Red", "41" },
    { "Green", "42" },
    { "Yellow", "43" },
    { "Blue", "44" },
    { "Magenta", "45" },
    { "Cyan", "46" },
    { "LightGray", "47" },
    { "DarkGray", "100" },
    { "LightRed", "101" },
    { "LightGreen", "102" },
    { "LightYellow", "103" },
    { "LightBlue", "104" },
    { "LightMagenta", "105" },
    { "LightCyan", "106" },
    { "White", "107" }
}};

// =================================================================================================
//     Basic Operators
// =================================================================================================

std::ostream& operator << ( std::ostream& out, Style const& style )
{
    out << "Foreground Color: " << style.foreground_color() << "\n";
    out << "Background Color: " << style.background_color() << "\n";
    out << "Bold:             " << ( style.bold() ? "true" : "false" ) << "\n";
    return out;
}

} // namespace utils
} // namespace genesis