MolGraphWriter.h

Go to the documentation of this file.

#ifndef INCLUDE_MOLASSEMBLER_MOL_GRAPH_WRITER_H
#define INCLUDE_MOLASSEMBLER_MOL_GRAPH_WRITER_H

#include "Molassembler/Graph/PrivateGraph.h"

namespace Scine {
namespace Molassembler {

class StereopermutatorList;
class AtomStereopermutator;
class BondStereopermutator;

struct MolGraphWriter {
  static const std::map<std::string, std::string>& elementBGColorMap();
  static const std::map<std::string, std::string>& elementTextColorMap();

  const PrivateGraph* const graphPtr;
  const StereopermutatorList* const stereopermutatorListPtr;

  MolGraphWriter(
    const PrivateGraph* passGraphPtr,
    const StereopermutatorList* passPermutatorListPtr
  );

  virtual ~MolGraphWriter() = default;

  /* Information */
  void operator() (std::ostream& os) const;
  void operator() (std::ostream& os, PrivateGraph::Vertex v) const;
  void operator() (std::ostream& os, const PrivateGraph::Edge& e) const;

  /* Display customization */
  virtual std::map<std::string, std::string> vertexAttributes(PrivateGraph::Vertex v) const;

  virtual std::string vertexLabel(PrivateGraph::Vertex v) const;

  virtual std::pair<std::string, std::string> fillFontColors(PrivateGraph::Vertex v) const;

  virtual std::map<std::string, std::string> edgeAttributes(const PrivateGraph::Edge& e) const;

  virtual std::string edgeColor(const PrivateGraph::Edge& e) const;

  virtual std::vector<std::string> edgeTooltips(AtomIndex source, AtomIndex target) const;

  virtual std::vector<std::string> atomStereopermutatorTooltips(
    const AtomStereopermutator& permutator
  ) const;

  virtual std::vector<std::string> bondStereopermutatorTooltips(
    const BondStereopermutator& permutator
  ) const;
};

} // namespace Molassembler
} // namespace Scine

#endif