source: trunk/lib/Gnuplot.h @ 37

// $Id: Gnuplot.h 36 2006-01-13 01:05:53Z jari $

#ifndef _theplu_svnstat_gnuplot_
#define _theplu_svnstat_gnuplot_

#include <cstdio>
#include <list>
#include <stdexcept>
#include <string>
#include <vector>

namespace theplu {
namespace svnstat {

  ///
  /// If something goes wrong in the use of the Gnuplot class, a
  /// GnuplotException is thrown.
  ///
  struct GnuplotException : public std::runtime_error
  { inline GnuplotException(const std::string &msg) : runtime_error(msg) {} };

  ///
  /// The Gnuplot class creates a pipe to 'gnuplot' and facilitates
  /// communication with the binary.
  ///
  /// Temporary files are created in directory /tmp. These temporaru
  /// files are removed on a normal program exit.
  ///
  class Gnuplot
  {
  public:
    ///
    /// This constructor sets up the pipe to the first gnuplot
    /// executable found in the PATH environment variable. The PATH
    /// variable must exist.
    ///
    /// @throw Throws a GnuplotException if a no PATH variable is
    /// found, if the gnuplot binary cannot be found, or if a pipe
    /// cannot to the gnuplot binary cannot be established.
    ///
    Gnuplot(void);

    ///
    /// The destructor deletes all temporary files created in the
    /// calls to plot_xy and plot_x. If the program execution fails to
    /// reach this destructor the temporary files will not be removed
    /// from the storage area.
    ///
    ~Gnuplot(void);

    ///
    /// Send arbitrary commands to Gnuplot.
    ///
    void command(std::string);

    ///
    /// Set the \a style of the line in the subsequent plot_xy or
    /// plot_y calls. The setting applies until this function is
    /// called again.
    ///
    /// @note The \a style is not checked to be valid.
    ///
    inline void linestyle(std::string style) { linestyle_=style; }

    ///
    /// Set the \a title of the line in the subsequent plot_xy or
    /// plot_y calls. The setting applies until this function is
    /// called again.
    ///
    inline void linetitle(std::string title) { linetitle_=title; }

    ///
    /// Plot the data \a y as a function of \a x using the Gnuplot
    /// 'plot' command. The \a x vector can be omitted as in normal
    /// Gnuplot usage.
    ///
    inline void
    plot(const std::vector<double>& y,
         const std::vector<double>& x=std::vector<double>())
    { plot(y,x,"plot"); }

    ///
    /// Plot the data \a y as a function of \a x using the Gnuplot
    /// 'replot' command. The \a x vector can be omitted as in normal
    /// Gnuplot usage.
    ///
    inline void
    replot(const std::vector<double>& y,
           const std::vector<double>& x=std::vector<double>())
    { plot(y,x,"replot"); }

  private:
    ///
    /// Copy constructor, not implemented.
    ///
    Gnuplot(const Gnuplot&);

    void acquire_program_path(const std::string&);

    ///
    /// @param \a plotcmd must be "plot" or "replot".
    ///
    void plot(const std::vector<double>& y, const std::vector<double>& x,
              const std::string& plotcmd);

    void tokenizer(const std::string& in, std::list<std::string>& tokens,
                   const std::string& delimiters = ":");

    // need to keep track of created files since the gnuplot command
    // is not executed until pclose on MacOSX, shouldn't the fflush
    // fix this in the command() member function?
    std::list<std::string> tempfiles_;
    std::string gnuplot_binary_;
    std::string linestyle_;
    std::string linetitle_;
    FILE* pipe_;
};

}} // end of namespace svnstat and namespace theplu

#endif