color.h

Go to the documentation of this file.

/* Author(s):     Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2010-03-23
 * Last modified: 2014-02-12
 *
 * License:
 *
 * Description:
 *
 *  Utilities for color manipulation.
 *
 * History:
 *
 */

#ifndef GEOMTOOLS_COLOR_H
#define GEOMTOOLS_COLOR_H 1

// Standard library:
#include <iostream>
#include <string>
#include <map>

// Third party:
// - Boost:
#include <boost/cstdint.hpp>
#include <boost/scoped_ptr.hpp>

namespace geomtools {

  class color
  {
  public:

    static const int COLOR_TEST = 0;

    // May collide with some macros from ncurses.h
    enum code_type {
      COLOR_INVALID     = -4,
      COLOR_TRANSPARENT = -3,
      COLOR_WHITE       = -2,
      COLOR_BLACK       = -1,
      COLOR_GREY        =  0,
      COLOR_RED         =  1,
      COLOR_GREEN       =  2,
      COLOR_BLUE        =  3,
      COLOR_MAGENTA     =  4,
      COLOR_CYAN        =  5,
      COLOR_YELLOW      =  6,
      COLOR_BROWN       =  7,
      COLOR_ORANGE      =  8,
      COLOR_DEFAULT     =  COLOR_GREY
    };

    static const std::string & invalid();
    static const std::string & transparent();
    static const std::string & white();
    static const std::string & black();
    static const std::string & grey();
    static const std::string & red();
    static const std::string & green();
    static const std::string & blue();
    static const std::string & magenta();
    static const std::string & cyan();
    static const std::string & brown();
    static const std::string & yellow();
    static const std::string & orange();
    static const std::string & default_color();

    struct constants
    {
      std::string invalid;
      std::string transparent;
      std::string white;
      std::string black;
      std::string grey;
      std::string red;
      std::string green;
      std::string blue;
      std::string magenta;
      std::string cyan;
      std::string brown;
      std::string yellow;
      std::string orange;
      std::string default_color;

      constants();

      static const constants & instance();
    };

  public:

    int32_t     code;         
    std::string name;         
    int32_t     red_amount;   
    int32_t     green_amount; 
    int32_t     blue_amount;  
    int32_t     alpha_amount; 

  public:

    color();

    color(code_type, const std::string &,
          int32_t, int32_t, int32_t, int32_t = 0);

    typedef std::map<std::string, code_type> color_map_type;

    class color_db
    {
    public:

      color_db();

      virtual ~color_db();

      //bool has_color(const string & id_) const;

      code_type get_color(const std::string & a_color_id) const;

      //void register_color(color, const string & id_);

      //void dump_colors(ostream & out_ = clog);

    private:

      color_map_type map_of_colors_; 

    };

    typedef boost::scoped_ptr<color_db> scoped_color_db_type;

  public:

    static const color_db & get_color_db();

    static code_type get_color(const std::string & a_name);

    struct context {

      enum encoding_type {
        ENCODING_NONE     = 0,
        ENCODING_BY_CODE  = 1,
        ENCODING_BY_VALUE = 2,
        ENCODING_BY_NAME  = 3
        //ENCODING_BY_COLOR = 4,
      };

      context();

      void reset();

      bool is_activated() const;

      void deactivate();

      bool encoded_by_code() const;

      void set_color_code(color::code_type);

      color::code_type get_color_code() const;

      bool encoded_by_value() const;

      void set_color_value(double);

      double get_color_value() const;

      bool encoded_by_name() const;

      void set_color_name(const std::string &);

      const std::string & get_color_name() const;

      /*
      bool encoded_by_color() const;

      void set_color(const color &);

      const color & get_color() const;
      */

      std::string str() const;

    private:

      encoding_type    _encoding_;     
      color::code_type _color_code_;   
      double           _color_value_;  
      std::string      _color_name_;   
      double           _transparency_; 

    };

  };

} // end of namespace geomtools

#endif // GEOMTOOLS_COLOR_H

/*
** Local Variables: --
** mode: c++ --
** c-file-style: "gnu" --
** tab-width: 2 --
** End: --
*/