ColourLineSpec.H

Go to the documentation of this file.

/* Copyright 2000-2018 Matt Flax <flatmax@flatmax.org>
   This file is part of GTK+ IOStream class set

   GTK+ IOStream 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 2 of the License, or
   (at your option) any later version.

   GTK+ IOStream 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 have received a copy of the GNU General Public License
   along with GTK+ IOStream
*/
#ifndef COLOURLINESPEC_H_
#define COLOURLINESPEC_H_

#include <stdlib.h>
#include <string.h>
#include <string>
#include <vector>
#include <gtk/gtk.h>

#include <cairo/cairo.h>

using namespace std;

#ifndef uint
typedef unsigned int uint;
#endif

template <int dummy>
class StandardColours {
protected:
    static int colourCntPrivate; 
    static const char *shortColoursPrivate[]; 
    static const char *X11ColoursPrivate[]; 
};
// setup the possible plot colours ...
template <int dummy> int StandardColours<dummy>::colourCntPrivate=10;
template <int dummy> const char *StandardColours<dummy>::shortColoursPrivate[]= {(char *)"b",(char *)"g",(char *)"r",(char *)"c",(char *)"m",(char *)"y",(char *)"w",(char *)"k",(char *)"o",(char *)"a"}; // standard colours
template <int dummy> const char *StandardColours<dummy>::X11ColoursPrivate[]= {(char *)"blue", (char *)"green", (char *)"red", (char *)"cyan", (char *)"magenta", (char *)"yellow", (char *)"white", (char *)"black", (char *)"orange", (char *)"gray"};

class ColourLineSpec : protected StandardColours<0> {
    bool sizeNotSpecified; 
    bool colourNotSpecified; 
    float size; 

#if GTK_MAJOR_VERSION==3
    GdkRGBA colour; 
#else
    GdkColor colour; 
#endif
public:

    vector<string> shortColours; 
    vector<string> X11Colours; 

    bool linePlot; 

    ColourLineSpec(void) {
        setColourAndLinesOrPoints("b1");
    }

    ColourLineSpec(const char* clsChar) {
        if (strlen(clsChar)==0)
            setColourAndLinesOrPoints("b1");
        else
            setColourAndLinesOrPoints(clsChar);
    }

    bool wasSizeSpecified(void){
        return !sizeNotSpecified;
    }

    bool wasColourSpecified(void){
        return !colourNotSpecified;
    }

    void setSize(int s){
        sizeNotSpecified=false;
        size=(float)s;
    }
    void setSize(float s){
        sizeNotSpecified=false;
        size=s;
    }

    float getSize(void) const {
        return size;
    }

#if GTK_MAJOR_VERSION>2
    void setColour(GdkRGBA c){
#else
    void setColour(GdkColor c){
#endif
        colourNotSpecified=false;
        colour=c;
    }

    void setColour(const char* c){
        colourNotSpecified=false;
#if GTK_MAJOR_VERSION>2
                    gdk_rgba_parse(&colour, c);
#else
        gdk_color_parse(c,&colour);
#endif
    }

#if GTK_MAJOR_VERSION>2
    GdkRGBA getColour(void) const {
#else
    GdkColor getColour(void){
#endif
        return colour;
    }

    gchar *getColourString(void){
#if GTK_MAJOR_VERSION>2
        return gdk_rgba_to_string(&colour);
#else
        return gdk_color_to_string(&colour);
#endif
    }

    void setColourAndLinesOrPoints(const char* clsChar) {
        sizeNotSpecified=true;
        colourNotSpecified=true;

        linePlot=1;
        string clsStr(clsChar);
#if GTK_MAJOR_VERSION>2
                    gdk_rgba_parse(&colour, "blue");
#else
        gdk_color_parse("blue",&colour);
#endif
        //cout<<"ColourLineSpec::setColourAndLinesOrPoints colour = "<<"blue"<<endl;
        if (shortColours.size()==X11Colours.size() && X11Colours.size()!=0){ // if the user has specified their own colours
            for (unsigned int i=0; i<X11Colours.size(); i++)
                if (clsStr.find(shortColours[i].c_str())!=string::npos) {
#if GTK_MAJOR_VERSION>2
                    gdk_rgba_parse(&colour, X11Colours[i].c_str());
#else
                    gdk_color_parse(X11Colours[i].c_str(),&colour);
#endif
                    colourNotSpecified=false; // indicate that the colour was specified
                    break;
                }
        } else {
            for (int i=0; i<colourCntPrivate; i++) // if the user didn't specify their own colours, then use the standard colours.
                if (clsStr.find(shortColoursPrivate[i])!=string::npos) {
#if GTK_MAJOR_VERSION>2
                    gdk_rgba_parse(&colour, X11ColoursPrivate[i]);
#else
                    gdk_color_parse(X11ColoursPrivate[i],&colour);
#endif
                    colourNotSpecified=false; // indicate that the colour was specified
                    //      cout<<"ColourLineSpec::setColourAndLinesOrPoints colour = "<<X11ColoursPrivate[i]<<endl;
                    break;
                }
        }

        if (clsStr.find(':')!=string::npos) { // check for the points plotting style
            linePlot=false;
            //cout<<"ColourLineSpec::setColourAndLinesOrPoints linePlot = "<<linePlot<<endl;
        } //else            cout<<"ColourLineSpec::setColourAndLinesOrPoints linePlot = "<<linePlot<<endl;

        size=1.;
        unsigned int minC=clsStr.find_first_of("0123456789");
        //cout<<"clsStr : "<<clsStr<<endl;
        if ((minC!=string::npos) & (minC<=clsStr.size())) {
            int maxC=clsStr.find_last_of("0123456789");
            size=atof(clsStr.substr(minC,maxC-minC+1).c_str());
            sizeNotSpecified=false; // indicate that the size was specified
        }
        //cout<<"ColourLineSpec::setColourAndLinesOrPoints size = "<<size<<endl;
    }

    ColourLineSpec &operator=(string &c){
        if (c.size()==0)
            setColourAndLinesOrPoints("b1");
        else
            setColourAndLinesOrPoints(c.c_str());
        return *this;
    }

    ColourLineSpec &operator=(const char *c){
        if (strlen(c)==0)
            setColourAndLinesOrPoints("b1");
        else
            setColourAndLinesOrPoints(c);
        return *this;
    }

    static const char ** getColourLabels(void){
        return shortColoursPrivate;
    }

    static const char *getColour(uint i) {
        return shortColoursPrivate[i%colourCntPrivate];
    }

    ColourLineSpec &operator>>(cairo_t  *cr){
        if (cr){
            //float maxVal=pow(2.,8.*(float)sizeof(colour.red));
            float maxVal = (float)(1<<8*sizeof(colour.red));
            cairo_set_source_rgb(cr, colour.red/maxVal, colour.green/maxVal, colour.blue/maxVal);
            cairo_set_line_width(cr, size);
        }
        return *this;
    }

        ColourLineSpec setRGBA(cairo_t  *cr, double alpha){
        if (cr){
            float maxVal = (float)(1<<8*sizeof(colour.red));
            cairo_set_source_rgba(cr, colour.red/maxVal, colour.green/maxVal, colour.blue/maxVal, alpha);
            cairo_set_line_width(cr, size);
        }
        return *this;
        }
};

#endif // COLOURLINESPEC_H_