source: trunk/lib/Graph.h @ 1280

Last change on this file since 1280 was 1280, checked in by Peter Johansson, 11 years ago

merged release 0.9 in to trunk

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 4.4 KB
Line 
1#ifndef _theplu_svndigest_graph_
2#define _theplu_svndigest_graph_
3
4// $Id: Graph.h 1280 2010-11-06 14:45:23Z peter $
5
6/*
7  Copyright (C) 2009 Jari Häkkinen, Peter Johansson
8  Copyright (C) 2010 Peter Johansson
9
10  This file is part of svndigest, http://dev.thep.lu.se/svndigest
11
12  svndigest is free software; you can redistribute it and/or modify it
13  under the terms of the GNU General Public License as published by
14  the Free Software Foundation; either version 3 of the License, or
15  (at your option) any later version.
16
17  svndigest is distributed in the hope that it will be useful, but
18  WITHOUT ANY WARRANTY; without even the implied warranty of
19  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20  General Public License for more details.
21
22  You should have received a copy of the GNU General Public License
23  along with svndigest. If not, see <http://www.gnu.org/licenses/>.
24*/
25
26#include <config.h>
27
28#include "Vector.h"
29
30#include <subversion-1/svn_types.h>
31
32#include <ctime>
33#include <string>
34#include <vector>
35
36#ifdef HAVE_PLPLOT
37#include <plplot/plstream.h>
38#else
39typedef int PLINT;
40typedef double PLFLT;
41typedef double plstream;
42#endif
43
44namespace theplu {
45namespace svndigest {
46
47  /**
48     Graph is used to generate plots in svndigest and is a specialized
49     wrapper to the plplot plot library, http://plplot.sourceforge.net/
50
51     Graph allows some axis label manipulation, setting pen colour,
52     and plotting lines.
53
54     Graph supports three graphics formats - portable network graphics
55     (png), scalable vector graphics (svg), and protable document
56     format (pdf) - if the underlying plplot library was built with
57     the appropriate modules. If not, rebuild and reinstall plplot.
58  */
59  class Graph
60  {
61  public:
62
63    /**
64       \brief Constructor
65
66       \a filename to be defined depending on whether we'll support
67       more output formats than SVG.
68
69       \note The plot legend is created in the destructioe, i.e., when
70       the graph object is destroyed.
71    */
72    Graph(const std::string& filename, const std::string& format);
73
74    /**
75       \brief Destructor
76    */
77    ~Graph(void);
78
79    /**
80       \brief Set the pen colour to use in next drawing call
81    */
82    void current_color(unsigned char r, unsigned char g, unsigned char b);
83
84    static bool date_xticks(void);
85
86    /**
87       \brief Plot \a data and use \a lines and \a label to compose
88       the legend label.
89
90       The legend will be a coloured line followed by \a lines
91       followed by \a label.
92
93       The label order in the legend is reverse to the plot order,
94       i.e., the last plotted line will get the top entry in the
95       legend, the second to last plotted line will be the second
96       legend entry, and so on.
97    */
98    void plot(const SumVector& data, const std::string& label,
99              unsigned int lines);
100
101    /**
102       Sets the right end of xrange to correspond to revision \a rev.
103     */
104    static void rev_max(svn_revnum_t rev);
105
106    /**
107       Sets the left end of xrange to correspond to revision \a rev.
108     */
109    static void rev_min(svn_revnum_t rev);
110
111    /**
112       \brief Function setting the dates.
113
114       The date is given in seconds (since 1/1 1970)
115    */
116    static void set_dates(const std::vector<time_t>& date);
117
118    /**
119       \brief Set x-axis tick value format to \a format. The format is
120       only used when dates are used.
121    */
122    void timeformat(const std::string& format);
123
124    static const std::vector<time_t>& xticks(void);
125
126    /**
127       \brief Set max y value in the plot
128
129       The plot area is (xstart,0) to (xend,\a ymax) where xend is
130       either the length of vector to plot (corresponds to latest
131       revision number) or the date of the last revision commit,
132       xstart is 0 or the date of the first commit.
133    */
134    double ymax(double ymax);
135
136  private:
137
138    // Copy constructor not implemented
139    Graph(const Graph&);
140
141    struct legend_data {
142      std::string label;
143      unsigned int lines;
144      PLINT r,g,b;
145    };
146
147    /**
148       \brief Set the pen colour to use in next drawing call
149    */
150    void current_color(const legend_data&);
151    void print_legend(void);
152    void staircase(svn_revnum_t rev0, PLFLT y0, svn_revnum_t rev1, PLFLT y1);
153    unsigned int tick_spacing(const double range) const;
154
155    std::vector<legend_data> legend_;
156    unsigned int plots_; // keep track of number of plots drawn
157    plstream pls_;
158    static svn_revnum_t rev_min_;
159    static svn_revnum_t rev_max_;
160    std::string timeformat_;
161    std::string title_;
162    static std::vector<time_t> xticks_;
163    PLFLT xmin_, xmax_, xrange_, ymin_, ymax_, yrange_;
164  };
165
166}} // end of namespace svndigest and namespace theplu
167
168#endif
Note: See TracBrowser for help on using the repository browser.