RhodeCode

/* -*- C++ -*-

 *

 * This file is a part of LEMON, a generic C++ optimization library

 *

 * Copyright (C) 2003-2008

 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport

 * (Egervary Research Group on Combinatorial Optimization, EGRES).

 *

 * Permission to use, modify and distribute this software is granted

 * provided that this copyright notice appears in all copies. For

 * precise terms see the accompanying LICENSE file.

 *

 * This software is provided "AS IS" with no warranty of any kind,

 * express or implied, and with no claim as to its suitability for any

 * purpose.

 *

 */

#ifndef LEMON_GRAPH_TO_EPS_H

#define LEMON_GRAPH_TO_EPS_H

#include <sys/time.h>

#ifdef WIN32

#include <lemon/bits/mingw32_time.h>

#endif

#include<iostream>

#include<fstream>

#include<sstream>

#include<algorithm>

#include<vector>

#include<ctime>

#include<lemon/math.h>

#include<lemon/bits/invalid.h>

#include<lemon/dim2.h>

#include<lemon/maps.h>

#include<lemon/color.h>

#include<lemon/bits/bezier.h>

///\ingroup eps_io

///\file

///\brief Simple graph drawer

///

///\author Alpar Juttner

namespace lemon {

///Default traits class of \ref GraphToEps

///Default traits class of \ref GraphToEps

///

///\c G is the type of the underlying graph.

template<class G>

struct DefaultGraphToEpsTraits

{

  typedef G Graph;

  typedef typename Graph::Node Node;

  typedef typename Graph::NodeIt NodeIt;

  typedef typename Graph::Arc Arc;

  typedef typename Graph::ArcIt ArcIt;

  typedef typename Graph::InArcIt InArcIt;

  typedef typename Graph::OutArcIt OutArcIt;

  const Graph &g;

  std::ostream& os;

  typedef ConstMap<typename Graph::Node,dim2::Point<double> > CoordsMapType;

  CoordsMapType _coords;

  ConstMap<typename Graph::Node,double > _nodeSizes;

  ConstMap<typename Graph::Node,int > _nodeShapes;

  ConstMap<typename Graph::Node,Color > _nodeColors;

  ConstMap<typename Graph::Arc,Color > _arcColors;

  ConstMap<typename Graph::Arc,double > _arcWidths;

  double _arcWidthScale;

  double _nodeScale;

  double _xBorder, _yBorder;

  double _scale;

  double _nodeBorderQuotient;

  bool _drawArrows;

  double _arrowLength, _arrowWidth;

  bool _showNodes, _showArcs;

  bool _enableParallel;

  double _parArcDist;

  bool _showNodeText;

  ConstMap<typename Graph::Node,bool > _nodeTexts;  

  double _nodeTextSize;

  bool _showNodePsText;

  ConstMap<typename Graph::Node,bool > _nodePsTexts;  

  char *_nodePsTextsPreamble;

  bool _undirected;

  bool _pleaseRemoveOsStream;

  bool _scaleToA4;

  std::string _title;

  std::string _copyright;

  enum NodeTextColorType 

    { DIST_COL=0, DIST_BW=1, CUST_COL=2, SAME_COL=3 } _nodeTextColorType;

  ConstMap<typename Graph::Node,Color > _nodeTextColors;

  bool _autoNodeScale;

  bool _autoArcWidthScale;

  bool _absoluteNodeSizes;

  bool _absoluteArcWidths;

  bool _negY;

  bool _preScale;

  ///Constructor

  ///Constructor

  ///\param _g is a reference to the graph to be printed

  ///\param _os is a reference to the output stream.

  ///\param _os is a reference to the output stream.

  ///\param _pros If it is \c true, then the \c ostream referenced by \c _os

  ///will be explicitly deallocated by the destructor.

  ///By default it is <tt>std::cout</tt>

  DefaultGraphToEpsTraits(const G &_g,std::ostream& _os=std::cout,

			  bool _pros=false) :

    g(_g), os(_os),

    _coords(dim2::Point<double>(1,1)), _nodeSizes(.01), _nodeShapes(0),

    _nodeColors(WHITE), _arcColors(BLACK),

    _arcWidths(1.0), _arcWidthScale(0.003),

    _nodeScale(1.0), _xBorder(10), _yBorder(10), _scale(1.0),

    _nodeBorderQuotient(.1),

    _drawArrows(false), _arrowLength(1), _arrowWidth(0.3),

    _showNodes(true), _showArcs(true),

    _enableParallel(false), _parArcDist(1),

    _showNodeText(false), _nodeTexts(false), _nodeTextSize(1),

    _showNodePsText(false), _nodePsTexts(false), _nodePsTextsPreamble(0),

    _pleaseRemoveOsStream(_pros), _scaleToA4(false),

    _nodeTextColorType(SAME_COL), _nodeTextColors(BLACK),

    _autoNodeScale(false),

    _autoArcWidthScale(false),

    _absoluteNodeSizes(false),

    _absoluteArcWidths(false),

    _negY(false),

    _preScale(true)

  {}

};

///Helper class to implement the named parameters of \ref graphToEps()

///Helper class to implement the named parameters of \ref graphToEps()

///\todo Is 'helper class' a good name for this?

///

///\todo Follow PostScript's DSC.

/// Use own dictionary.

///\todo Useful new features.

/// - Linestyles: dotted, dashed etc.

/// - A second color and percent value for the lines.

template<class T> class GraphToEps : public T 

{

  // Can't believe it is required by the C++ standard

  using T::g;

  using T::os;

  using T::_coords;

  using T::_nodeSizes;

  using T::_nodeShapes;

  using T::_nodeColors;

  using T::_arcColors;

  using T::_arcWidths;

  using T::_arcWidthScale;

  using T::_nodeScale;

  using T::_xBorder;

  using T::_yBorder;

  using T::_scale;

  using T::_nodeBorderQuotient;

  using T::_drawArrows;

  using T::_arrowLength;

  using T::_arrowWidth;

  using T::_showNodes;

  using T::_showArcs;

  using T::_enableParallel;

  using T::_parArcDist;

  using T::_showNodeText;

  using T::_nodeTexts;  

  using T::_nodeTextSize;

  using T::_showNodePsText;

  using T::_nodePsTexts;  

  using T::_nodePsTextsPreamble;

  using T::_undirected;

  using T::_pleaseRemoveOsStream;

  using T::_scaleToA4;

  GraphToEps<T> &scaleToA4() {_scaleToA4=true;return *this;}

  ///Enables parallel arcs

  ///Enables parallel arcs

  GraphToEps<T> &enableParallel(bool b=true) {_enableParallel=b;return *this;}

  ///Sets the distance 

  ///Sets the distance 

  ///

  GraphToEps<T> &parArcDist(double d) {_parArcDist*=d;return *this;}

  ///Hides the arcs

  ///Hides the arcs

  ///

  GraphToEps<T> &hideArcs(bool b=true) {_showArcs=!b;return *this;}

  ///Hides the nodes

  ///Hides the nodes

  ///

  GraphToEps<T> &hideNodes(bool b=true) {_showNodes=!b;return *this;}

  ///Sets the size of the node texts

  ///Sets the size of the node texts

  ///

  GraphToEps<T> &nodeTextSize(double d) {_nodeTextSize=d;return *this;}

  ///Sets the color of the node texts to be different from the node color

  ///Sets the color of the node texts to be as different from the node color

  ///as it is possible

  ///

  GraphToEps<T> &distantColorNodeTexts()

  {_nodeTextColorType=DIST_COL;return *this;}

  ///Sets the color of the node texts to be black or white and always visible.

  ///Sets the color of the node texts to be black or white according to

  ///which is more 

  ///different from the node color

  ///

  GraphToEps<T> &distantBWNodeTexts()

  {_nodeTextColorType=DIST_BW;return *this;}

  ///Gives a preamble block for node Postscript block.

  ///Gives a preamble block for node Postscript block.

  ///

  ///\sa nodePsTexts()

  GraphToEps<T> & nodePsTextsPreamble(const char *str) {

    _nodePsTextsPreamble=str ;return *this;

  }

  ///Sets whether the the graph is undirected

  ///Sets whether the the graph is undirected

  ///

  GraphToEps<T> &undirected(bool b=true) {_undirected=b;return *this;}

  ///Sets whether the the graph is directed

  ///Sets whether the the graph is directed.

  ///Use it to show the edges as a pair of directed ones.

  ///Sets the title.

  ///Sets the title of the generated image,

  ///namely it inserts a <tt>%%Title:</tt> DSC field to the header of

  ///the EPS file.

  GraphToEps<T> &title(const std::string &t) {_title=t;return *this;}

  ///Sets the copyright statement.

  ///Sets the copyright statement of the generated image,

  ///namely it inserts a <tt>%%Copyright:</tt> DSC field to the header of

  ///the EPS file.

  ///\todo Multiline copyright notice could be supported.

  GraphToEps<T> &copyright(const std::string &t) {_copyright=t;return *this;}

protected:

  bool isInsideNode(dim2::Point<double> p, double r,int t) 

  {

    switch(t) {

    case CIRCLE:

    case MALE:

    case FEMALE:

      return p.normSquare()<=r*r;

    case SQUARE:

      return p.x<=r&&p.x>=-r&&p.y<=r&&p.y>=-r;

    case DIAMOND:

      return p.x+p.y<=r && p.x-p.y<=r && -p.x+p.y<=r && -p.x-p.y<=r;

    }

    return false;

  }

public:

  ~GraphToEps() { }

  ///Draws the graph.

  ///Like other functions using

  ///\ref named-templ-func-param "named template parameters",

  ///this function calles the algorithm itself, i.e. in this case

  ///it draws the graph.

  void run() {

    ///\todo better 'epsilon' would be nice here.

    const double EPSILON=1e-9;

    if(dontPrint) return;

    os << "%!PS-Adobe-2.0 EPSF-2.0\n";

    if(_title.size()>0) os << "%%Title: " << _title << '\n';

     if(_copyright.size()>0) os << "%%Copyright: " << _copyright << '\n';

//        << "%%Copyright: XXXX\n"

    os << "%%Creator: LEMON, graphToEps()\n";

    {

      char cbuf[50];

      timeval tv;

      gettimeofday(&tv, 0);

      ctime_r(&tv.tv_sec,cbuf);

      os << "%%CreationDate: " << cbuf;

    }

    if (_autoArcWidthScale) {

      double max_w=0;

      for(ArcIt e(g);e!=INVALID;++e)

	max_w=std::max(double(_arcWidths[e]),max_w);

      ///\todo better 'epsilon' would be nice here.

      if(max_w>EPSILON) {

	_arcWidthScale/=max_w;

      }

    }

    if (_autoNodeScale) {

      double max_s=0;

      for(NodeIt n(g);n!=INVALID;++n)

	max_s=std::max(double(_nodeSizes[n]),max_s);

      ///\todo better 'epsilon' would be nice here.

      if(max_s>EPSILON) {

	_nodeScale/=max_s;

      }

    }

    double diag_len = 1;

    if(!(_absoluteNodeSizes&&_absoluteArcWidths)) {

      dim2::BoundingBox<double> bb;

      for(NodeIt n(g);n!=INVALID;++n) bb.add(mycoords[n]);

      if (bb.empty()) {

	bb = dim2::BoundingBox<double>(dim2::Point<double>(0,0));

      }

      diag_len = std::sqrt((bb.bottomLeft()-bb.topRight()).normSquare());

      if(diag_len<EPSILON) diag_len = 1;

      if(!_absoluteNodeSizes) _nodeScale*=diag_len;

      if(!_absoluteArcWidths) _arcWidthScale*=diag_len;

    }

    dim2::BoundingBox<double> bb;

    for(NodeIt n(g);n!=INVALID;++n) {

      double ns=_nodeSizes[n]*_nodeScale;

      dim2::Point<double> p(ns,ns);

      switch(_nodeShapes[n]) {

      case CIRCLE:

      case SQUARE:

      case DIAMOND:

	bb.add(p+mycoords[n]);

	bb.add(-p+mycoords[n]);

	break;

      case MALE:

	bb.add(-p+mycoords[n]);

	bb.add(dim2::Point<double>(1.5*ns,1.5*std::sqrt(3.0)*ns)+mycoords[n]);

	break;

      case FEMALE: