deba@1137: /* -*- C++ -*-
ladanyi@1435:  * lemon/graph_writer.h - Part of LEMON, a generic C++ optimization library
deba@1137:  *
alpar@1164:  * Copyright (C) 2005 Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
alpar@1359:  * (Egervary Research Group on Combinatorial Optimization, EGRES).
deba@1137:  *
deba@1137:  * Permission to use, modify and distribute this software is granted
deba@1137:  * provided that this copyright notice appears in all copies. For
deba@1137:  * precise terms see the accompanying LICENSE file.
deba@1137:  *
deba@1137:  * This software is provided "AS IS" with no warranty of any kind,
deba@1137:  * express or implied, and with no claim as to its suitability for any
deba@1137:  * purpose.
deba@1137:  *
deba@1137:  */
deba@1137: 
alpar@1287: ///\ingroup io_group
deba@1137: ///\file
alpar@1287: ///\brief Lemon Graph Format writer.
deba@1137: 
deba@1214: #ifndef LEMON_GRAPH_WRITER_H
deba@1214: #define LEMON_GRAPH_WRITER_H
deba@1137: 
deba@1137: #include <iostream>
deba@1137: 
deba@1137: #include <lemon/error.h>
deba@1409: #include <lemon/lemon_writer.h>
deba@1137: 
deba@1137: namespace lemon {
deba@1137: 
deba@1333:   /// \addtogroup io_group
deba@1333:   /// @{
deba@1333: 
deba@1137:   /// \brief The graph writer class.
deba@1137:   ///
athos@1526:   /// The \c GraphWriter class provides the graph output. 
athos@1526:   /// Before you read this documentation it might be useful to read the general
athos@1526:   /// description of  \ref graph-io-page "Graph Input-Output".
athos@1526:   /// To write a graph
athos@1526:   /// you should first give writing commands to the writer. You can declare
athos@1526:   /// write commands as \c NodeMap or \c EdgeMap writing and labeled Node and
deba@1333:   /// Edge writing.
deba@1333:   ///
deba@1333:   /// \code
deba@1333:   /// GraphWriter<ListGraph> writer(std::cout, graph);
deba@1333:   /// \endcode
deba@1333:   ///
deba@1394:   /// The \c writeNodeMap() function declares a \c NodeMap writing 
deba@1394:   /// command in the \c GraphWriter. You should give as parameter 
deba@1394:   /// the name of the map and the map object. The NodeMap writing 
deba@1394:   /// command with name "id" should write a unique map because it 
athos@1526:   /// is regarded as ID map (such a map is essential if the graph has edges).
deba@1333:   ///
deba@1333:   /// \code
deba@1333:   /// IdMap<ListGraph, Node> nodeIdMap;
deba@1394:   /// writer.writeNodeMap("id", nodeIdMap);
deba@1333:   ///
deba@1421:   /// writer.writeNodeMap("coords", coords);
deba@1394:   /// writer.writeNodeMap("color", colorMap);
deba@1333:   /// \endcode
deba@1333:   ///
deba@1394:   /// With the \c writeEdgeMap() member function you can give an edge map
deba@1333:   /// writing command similar to the NodeMaps.
deba@1333:   ///
deba@1333:   /// \code
deba@1333:   /// DescriptorMap<ListGraph, Edge, ListGraph::EdgeMap<int> > 
deba@1333:   ///   edgeDescMap(graph);
deba@1394:   /// writer.writeEdgeMap("descriptor", edgeDescMap);
deba@1333:   ///
deba@1394:   /// writer.writeEdgeMap("weight", weightMap);
deba@1394:   /// writer.writeEdgeMap("label", labelMap);
deba@1333:   /// \endcode
deba@1333:   ///
deba@1394:   /// With \c writeNode() and \c writeEdge() functions you can 
athos@1526:   /// point out Nodes and Edges in the graph. For example, you can 
athos@1526:   /// write out the source and target of a maximum flow instance.
deba@1333:   ///
deba@1333:   /// \code
deba@1394:   /// writer.writeNode("source", sourceNode);
deba@1394:   /// writer.writeNode("target", targetNode);
deba@1333:   ///
deba@1394:   /// writer.writeEdge("observed", edge);
deba@1333:   /// \endcode
deba@1333:   ///
deba@1333:   /// After you give all write commands you must call the \c run() member
athos@1526:   /// function, which executes all the writing commands.
deba@1333:   ///
deba@1333:   /// \code
deba@1333:   /// writer.run();
deba@1333:   /// \endcode
deba@1333:   ///
alpar@1287:   /// \see DefaultWriterTraits
alpar@1287:   /// \see QuotedStringWriter
deba@1333:   /// \see IdMap
deba@1333:   /// \see DescriptorMap
deba@1421:   /// \see \ref GraphReader
alpar@1138:   /// \see \ref graph-io-page
deba@1333:   /// \author Balazs Dezso
deba@1137:   template <typename _Graph, typename _WriterTraits = DefaultWriterTraits> 
deba@1137:   class GraphWriter {
deba@1137:   public:
deba@1137:     
deba@1137:     typedef _Graph Graph;
deba@1137:     typedef typename Graph::Node Node;
deba@1137:     typedef typename Graph::Edge Edge;
deba@1137: 
deba@1137:     typedef _WriterTraits WriterTraits;
deba@1409: 
deba@1137:     /// \brief Construct a new GraphWriter.
deba@1137:     ///
athos@1526:     /// This function constructs a new GraphWriter to write the given graph
deba@1409:     /// to the given stream.
deba@1208:     GraphWriter(std::ostream& _os, const Graph& _graph) 
deba@1409:       : writer(new LemonWriter(_os)), own_writer(true), 
deba@1421: 	nodeset_writer(*writer, _graph, std::string()),
deba@1421: 	edgeset_writer(*writer, _graph, nodeset_writer, std::string()),
deba@1409: 	node_writer(*writer, nodeset_writer, std::string()),
deba@1409: 	edge_writer(*writer, edgeset_writer, std::string()),
deba@1409: 	attribute_writer(*writer, std::string()) {}
deba@1137: 
deba@1409:     /// \brief Construct a new GraphWriter.
deba@1409:     ///
athos@1526:     /// This function constructs a new GraphWriter to write the given graph
deba@1409:     /// to the given file.
deba@1409:     GraphWriter(const std::string& _filename, const Graph& _graph) 
deba@1409:       : writer(new LemonWriter(_filename)), own_writer(true), 
deba@1421: 	nodeset_writer(*writer, _graph, std::string()),
deba@1421: 	edgeset_writer(*writer, _graph, nodeset_writer, std::string()),
deba@1409: 	node_writer(*writer, nodeset_writer, std::string()),
deba@1409: 	edge_writer(*writer, edgeset_writer, std::string()),
deba@1409: 	attribute_writer(*writer, std::string()) {}
deba@1409: 
deba@1409:     /// \brief Construct a new GraphWriter.
deba@1409:     ///
athos@1526:     /// This function constructs a new GraphWriter to write the given graph
athos@1526:     /// to the given LemonReader.
deba@1409:     GraphWriter(LemonWriter& _writer, const Graph& _graph)
deba@1409:       : writer(_writer), own_writer(false), 
deba@1421: 	nodeset_writer(*writer, _graph, std::string()),
deba@1421: 	edgeset_writer(*writer, _graph, nodeset_writer, std::string()),
deba@1409: 	node_writer(*writer, nodeset_writer, std::string()),
deba@1409: 	edge_writer(*writer, edgeset_writer, std::string()),
deba@1409: 	attribute_writer(*writer, std::string()) {}
deba@1137: 
deba@1137:     /// \brief Destruct the graph writer.
deba@1137:     ///
athos@1526:     /// This function destructs the graph writer.
deba@1137:     ~GraphWriter() {
deba@1409:       if (own_writer) 
deba@1409: 	delete writer;
deba@1137:     }
deba@1137: 
athos@1526:     /// \brief Issue a new node map writing command for the writer.
deba@1137:     ///
athos@1526:    /// This function issues a new <i> node map writing command</i> to the writer.
deba@1137:     template <typename Map>
deba@1394:     GraphWriter& writeNodeMap(std::string name, const Map& map) {
deba@1421:       nodeset_writer.writeNodeMap(name, map);
deba@1409:       return *this;
deba@1137:     }
deba@1137: 
athos@1526:     /// \brief Issue a new node map writing command for the writer.
deba@1137:     ///
athos@1526:    /// This function issues a new <i> node map writing command</i> to the writer.
deba@1137:     template <typename Writer, typename Map>
deba@1394:     GraphWriter& writeNodeMap(std::string name, const Map& map, 
deba@1421: 			      const Writer& writer = Writer()) {
deba@1421:       nodeset_writer.writeNodeMap(name, map, writer);
deba@1137:       return *this;
deba@1137:     }
deba@1137: 
deba@1137: 
athos@1526:     /// \brief Issue a new edge map writing command for the writer.
deba@1137:     ///
athos@1526:    /// This function issues a new <i> edge map writing command</i> to the writer.
deba@1137:     template <typename Map>
deba@1394:     GraphWriter& writeEdgeMap(std::string name, const Map& map) { 
deba@1421:       edgeset_writer.writeEdgeMap(name, map);
deba@1409:       return *this;
deba@1137:     }
deba@1137: 
deba@1137: 
athos@1526:     /// \brief Issue a new edge map writing command for the writer.
deba@1137:     ///
athos@1526:    /// This function issues a new <i> edge map writing command</i> to the writer.
deba@1137:     template <typename Writer, typename Map>
deba@1409:     GraphWriter& writeEdgeMap(std::string name, const Map& map,
deba@1421: 			      const Writer& writer = Writer()) {
deba@1421:       edgeset_writer.writeEdgeMap(name, map, writer);
deba@1137:       return *this;
deba@1137:     }
deba@1137: 
athos@1526:     /// \brief Issue a new labeled node writing command to the writer.
deba@1137:     ///
athos@1526:     /// This function issues a new <i> labeled node writing command</i> 
athos@1526:     /// to the writer.
deba@1394:     GraphWriter& writeNode(std::string name, const Node& node) {
deba@1409:       node_writer.writeNode(name, node);
deba@1137:       return *this;
deba@1137:     }
deba@1137: 
athos@1526:     /// \brief Issue a new labeled edge writing command to the writer.
deba@1137:     ///
athos@1526:     /// This function issues a new <i> labeled edge writing command</i> 
athos@1526:     /// to the writer.
deba@1394:     GraphWriter& writeEdge(std::string name, const Edge& edge) {
deba@1409:       edge_writer.writeEdge(name, edge);
deba@1409:     }
deba@1409: 
athos@1526:     /// \brief Issue a new attribute writing command.
deba@1409:     ///
athos@1526:     /// This function issues a new <i> attribute writing command</i> 
athos@1526:     /// to the writer.
deba@1409:     template <typename Value>
deba@1409:     GraphWriter& writeAttribute(std::string name, const Value& value) {
deba@1409:       attribute_writer.writeAttribute(name, value);
deba@1409:       return *this;
deba@1409:     }
deba@1409:     
athos@1526:     /// \brief Issue a new attribute writing command.
deba@1409:     ///
athos@1526:     /// This function issues a new <i> attribute writing command</i> 
athos@1526:     /// to the writer.
deba@1409:     template <typename Writer, typename Value>
deba@1409:     GraphWriter& writeAttribute(std::string name, const Value& value, 
deba@1409: 			       const Writer& writer) {
deba@1409:       attribute_writer.writeAttribute<Writer>(name, value, writer);
deba@1137:       return *this;
deba@1137:     }
deba@1137: 
deba@1409:     /// \brief Conversion operator to LemonWriter.
deba@1409:     ///
athos@1526:     /// Conversion operator to LemonWriter. It makes possible
deba@1409:     /// to access the encapsulated \e LemonWriter, this way
deba@1409:     /// you can attach to this writer new instances of 
deba@1409:     /// \e LemonWriter::SectionWriter.
deba@1409:     operator LemonWriter&() {
deba@1409:       return *writer;
deba@1396:     }
deba@1396: 
athos@1526:     /// \brief Executes the writing commands.
deba@1137:     ///
athos@1526:     /// Executes the writing commands.
deba@1409:     void run() {
deba@1409:       writer->run();
deba@1137:     }
deba@1137: 
deba@1429:     /// \brief Write the id of the given node.
deba@1429:     ///
deba@1429:     /// It writes the id of the given node. If there was written an "id"
athos@1526:     /// named node map then it will write the map value belonging to the node.
deba@1429:     void writeId(std::ostream& os, const Node& item) const {
deba@1429:       nodeset_writer.writeId(os, item);
deba@1429:     } 
deba@1429: 
deba@1429:     /// \brief Write the id of the given edge.
deba@1429:     ///
deba@1429:     /// It writes the id of the given edge. If there was written an "id"
athos@1526:     /// named edge map then it will write the map value belonging to the edge.
deba@1429:     void writeId(std::ostream& os, const Edge& item) const {
deba@1429:       edgeset_writer.writeId(os, item);
deba@1429:     } 
deba@1429: 
deba@1137:   private:
deba@1137: 
deba@1409:     LemonWriter* writer;
deba@1409:     bool own_writer;
deba@1137: 
deba@1409:     NodeSetWriter<Graph, WriterTraits> nodeset_writer;
deba@1409:     EdgeSetWriter<Graph, WriterTraits> edgeset_writer;
deba@1409: 
deba@1409:     NodeWriter<Graph> node_writer;
deba@1409:     EdgeWriter<Graph> edge_writer;
deba@1409:     
deba@1409:     AttributeWriter<WriterTraits> attribute_writer;
deba@1137:   };
deba@1137: 
deba@1409: 
deba@1333:   /// \brief Write a graph to the output.
deba@1333:   ///
deba@1333:   /// Write a graph to the output.
deba@1333:   /// \param os The output stream.
deba@1333:   /// \param g The graph.
deba@1333:   /// \param capacity The capacity map.
deba@1333:   /// \param s The source node.
deba@1333:   /// \param t The target node.
deba@1333:   /// \param cost The cost map.
deba@1208:   template<typename Graph, typename CapacityMap, typename CostMap>
deba@1208:   void writeGraph(std::ostream& os, const Graph &g, 
deba@1208: 		  const CapacityMap& capacity, const typename Graph::Node &s,
deba@1208: 		  const typename Graph::Node &t, const CostMap& cost) {
deba@1394:     GraphWriter<Graph> writer(os, g);
deba@1208:     IdMap<Graph, typename Graph::Node> nodeIdMap(g);
deba@1394:     writer.writeNodeMap("id", nodeIdMap);
deba@1208:     IdMap<Graph, typename Graph::Edge> edgeIdMap(g);
deba@1394:     writer.writeEdgeMap("id", edgeIdMap);
deba@1394:     writer.writeEdgeMap("capacity", capacity);
deba@1394:     writer.writeEdgeMap("cost", cost);
deba@1394:     writer.writeNode("source", s);
deba@1394:     writer.writeNode("target", t);
deba@1394:     writer.run();
deba@1208:   }
deba@1208: 
deba@1333:   /// \brief Write a graph to the output.
deba@1333:   ///
deba@1333:   /// Write a graph to the output.
deba@1333:   /// \param os The output stream.
deba@1333:   /// \param g The graph.
deba@1333:   /// \param capacity The capacity map.
deba@1333:   /// \param s The source node.
deba@1333:   /// \param t The target node.
deba@1297:   template<typename Graph, typename CapacityMap>
deba@1208:   void writeGraph(std::ostream& os, const Graph &g, 
deba@1208: 		  const CapacityMap& capacity, const typename Graph::Node &s,
deba@1208: 		  const typename Graph::Node &t) {
deba@1394:     GraphWriter<Graph> writer(os, g);
deba@1208:     IdMap<Graph, typename Graph::Node> nodeIdMap(g);
deba@1394:     writer.writeNodeMap("id", nodeIdMap);
deba@1208:     IdMap<Graph, typename Graph::Edge> edgeIdMap(g);
deba@1394:     writer.writeEdgeMap("id", edgeIdMap);
deba@1394:     writer.writeEdgeMap("capacity", capacity);
deba@1394:     writer.writeNode("source", s);
deba@1394:     writer.writeNode("target", t);
deba@1394:     writer.run();
deba@1208:   }
deba@1208: 
deba@1333:   /// \brief Write a graph to the output.
deba@1333:   ///
deba@1333:   /// Write a graph to the output.
deba@1333:   /// \param os The output stream.
deba@1333:   /// \param g The graph.
deba@1333:   /// \param capacity The capacity map.
deba@1333:   /// \param s The source node.
deba@1208:   template<typename Graph, typename CapacityMap>
deba@1208:   void writeGraph(std::ostream& os, const Graph &g, 
deba@1208: 		  const CapacityMap& capacity, const typename Graph::Node &s) {
deba@1394:     GraphWriter<Graph> writer(os, g);
deba@1208:     IdMap<Graph, typename Graph::Node> nodeIdMap(g);
deba@1394:     writer.writeNodeMap("id", nodeIdMap);
deba@1208:     IdMap<Graph, typename Graph::Edge> edgeIdMap(g);
deba@1394:     writer.writeEdgeMap("id", edgeIdMap);
deba@1394:     writer.writeEdgeMap("capacity", capacity);
deba@1394:     writer.writeNode("source", s);
deba@1394:     writer.run();
deba@1208:   }
deba@1333: 
deba@1333:   /// \brief Write a graph to the output.
deba@1333:   ///
deba@1333:   /// Write a graph to the output.
deba@1333:   /// \param os The output stream.
deba@1333:   /// \param g The graph.
deba@1333:   /// \param capacity The capacity map.
deba@1208:   template<typename Graph, typename CapacityMap>
deba@1208:   void writeGraph(std::ostream& os, const Graph &g, 
deba@1208: 		  const CapacityMap& capacity) {
deba@1394:     GraphWriter<Graph> writer(os, g);
deba@1208:     IdMap<Graph, typename Graph::Node> nodeIdMap(g);
deba@1394:     writer.writeNodeMap("id", nodeIdMap);
deba@1208:     IdMap<Graph, typename Graph::Edge> edgeIdMap(g);
deba@1394:     writer.writeEdgeMap("id", edgeIdMap);
deba@1394:     writer.writeEdgeMap("capacity", capacity);
deba@1394:     writer.run();
deba@1208:   }
deba@1333: 
deba@1333:   /// \brief Write a graph to the output.
deba@1333:   ///
deba@1333:   /// Write a graph to the output.
deba@1333:   /// \param os The output stream.
deba@1333:   /// \param g The graph.
deba@1208:   template<typename Graph>
deba@1208:   void writeGraph(std::ostream& os, const Graph &g) {
deba@1394:     GraphWriter<Graph> writer(os, g);
deba@1208:     IdMap<Graph, typename Graph::Node> nodeIdMap(g);
deba@1394:     writer.writeNodeMap("id", nodeIdMap);
deba@1208:     IdMap<Graph, typename Graph::Edge> edgeIdMap(g);
deba@1394:     writer.writeEdgeMap("id", edgeIdMap);
deba@1394:     writer.run();
deba@1208:   }
deba@1208: 
deba@1421:   /// \brief The undirected graph writer class.
deba@1421:   ///
deba@1421:   /// The \c UndirGraphWriter class provides the undir graph output. To write 
athos@1526:   /// a graph you should first give writing commands to the writer. You can 
deba@1421:   /// declare write command as \c NodeMap, \c EdgeMap or \c UndirEdgeMap 
deba@1421:   /// writing and labeled Node, Edge or UndirEdge writing.
deba@1421:   ///
deba@1421:   /// \code
deba@1421:   /// UndirGraphWriter<UndirListGraph> writer(std::cout, graph);
deba@1421:   /// \endcode
deba@1421:   ///
deba@1421:   /// The \c writeNodeMap() function declares a \c NodeMap writing 
deba@1421:   /// command in the \c UndirGraphWriter. You should give as parameter 
deba@1421:   /// the name of the map and the map object. The NodeMap writing 
deba@1421:   /// command with name "id" should write a unique map because it 
deba@1421:   /// is regarded as ID map.
deba@1421:   ///
deba@1421:   /// \code
deba@1421:   /// IdMap<UndirListGraph, Node> nodeIdMap;
deba@1421:   /// writer.writeNodeMap("id", nodeIdMap);
deba@1421:   ///
deba@1421:   /// writer.writeNodeMap("coords", coords);
deba@1421:   /// writer.writeNodeMap("color", colorMap);
deba@1421:   /// \endcode
deba@1421:   ///
deba@1421:   /// With the \c writeUndirEdgeMap() member function you can give an 
deba@1421:   /// undirected edge map writing command similar to the NodeMaps.
deba@1421:   ///
deba@1421:   /// \code
deba@1421:   /// DescriptorMap<ListGraph, Edge, ListGraph::EdgeMap<int> > 
deba@1421:   ///   edgeDescMap(graph);
deba@1421:   /// writer.writeUndirEdgeMap("descriptor", edgeDescMap);
deba@1421:   ///
deba@1421:   /// writer.writeUndirEdgeMap("weight", weightMap);
deba@1421:   /// writer.writeUndirEdgeMap("label", labelMap);
deba@1421:   /// \endcode
deba@1421:   /// 
deba@1421:   /// The EdgeMap handling is just a syntactical sugar. It writes
deba@1421:   /// two undirected edge map with '+' and '-' prefix in the name.
deba@1421:   ///
deba@1421:   /// \code
deba@1421:   /// writer.writeEdgeMap("capacity", capacityMap);
deba@1421:   /// \endcode
deba@1421:   ///
deba@1421:   ///
deba@1421:   /// With \c writeNode() and \c writeUndirEdge() functions you can 
athos@1526:   /// designate nodes and undirected edges in the graph. For example, you can 
deba@1421:   /// write out the source and target of the graph.
deba@1421:   ///
deba@1421:   /// \code
deba@1421:   /// writer.writeNode("source", sourceNode);
deba@1421:   /// writer.writeNode("target", targetNode);
deba@1421:   ///
deba@1421:   /// writer.writeUndirEdge("observed", undirEdge);
deba@1421:   /// \endcode
deba@1421:   ///
deba@1421:   /// After you give all write commands you must call the \c run() member
athos@1526:   /// function, which executes all the writing commands.
deba@1421:   ///
deba@1421:   /// \code
deba@1421:   /// writer.run();
deba@1421:   /// \endcode
deba@1421:   ///
deba@1421:   /// \see DefaultWriterTraits
deba@1421:   /// \see QuotedStringWriter
deba@1421:   /// \see IdMap
deba@1421:   /// \see DescriptorMap
deba@1421:   /// \see \ref GraphWriter
deba@1421:   /// \see \ref graph-io-page
deba@1421:   /// \author Balazs Dezso
deba@1421:   template <typename _Graph, typename _WriterTraits = DefaultWriterTraits> 
deba@1421:   class UndirGraphWriter {
deba@1421:   public:
deba@1421:     
deba@1421:     typedef _Graph Graph;
deba@1421:     typedef typename Graph::Node Node;
deba@1421:     typedef typename Graph::Edge Edge;
deba@1421:     typedef typename Graph::UndirEdge UndirEdge;
deba@1421: 
deba@1421:     typedef _WriterTraits WriterTraits;
deba@1421: 
deba@1421:     /// \brief Construct a new UndirGraphWriter.
deba@1421:     ///
deba@1421:     /// Construct a new UndirGraphWriter. It writes the given graph
deba@1421:     /// to the given stream.
deba@1421:     UndirGraphWriter(std::ostream& _os, const Graph& _graph) 
deba@1421:       : writer(new LemonWriter(_os)), own_writer(true), 
deba@1421: 	nodeset_writer(*writer, _graph, std::string()),
deba@1421: 	undir_edgeset_writer(*writer, _graph, nodeset_writer, std::string()),
deba@1421: 	node_writer(*writer, nodeset_writer, std::string()),
deba@1421: 	undir_edge_writer(*writer, undir_edgeset_writer, std::string()),
deba@1421: 	attribute_writer(*writer, std::string()) {}
deba@1421: 
deba@1421:     /// \brief Construct a new UndirGraphWriter.
deba@1421:     ///
athos@1526:     /// Construct a new UndirGraphWriter. It writes the given graph
deba@1421:     /// to the given file.
deba@1421:     UndirGraphWriter(const std::string& _filename, const Graph& _graph) 
deba@1421:       : writer(new LemonWriter(_filename)), own_writer(true), 
deba@1421: 	nodeset_writer(*writer, _graph, std::string()),
deba@1421: 	undir_edgeset_writer(*writer, _graph, nodeset_writer, std::string()),
deba@1421: 	node_writer(*writer, nodeset_writer, std::string()),
deba@1421: 	undir_edge_writer(*writer, undir_edgeset_writer, std::string()),
deba@1421: 	attribute_writer(*writer, std::string()) {}
deba@1421: 
deba@1421:     /// \brief Construct a new UndirGraphWriter.
deba@1421:     ///
athos@1526:     /// Construct a new UndirGraphWriter. It writes the given graph
deba@1421:     /// to given LemonReader.
deba@1421:     UndirGraphWriter(LemonWriter& _writer, const Graph& _graph)
deba@1421:       : writer(_writer), own_writer(false), 
deba@1421: 	nodeset_writer(*writer, _graph, std::string()),
deba@1421: 	undir_edgeset_writer(*writer, _graph, nodeset_writer, std::string()),
deba@1421: 	node_writer(*writer, nodeset_writer, std::string()),
deba@1421: 	undir_edge_writer(*writer, undir_edgeset_writer, std::string()),
deba@1421: 	attribute_writer(*writer, std::string()) {}
deba@1421: 
deba@1421:     /// \brief Destruct the graph writer.
deba@1421:     ///
deba@1421:     /// Destruct the graph writer.
deba@1421:     ~UndirGraphWriter() {
deba@1421:       if (own_writer) 
deba@1421: 	delete writer;
deba@1421:     }
deba@1421: 
athos@1526:     /// \brief Issue a new node map writing command to the writer.
deba@1421:     ///
athos@1526:    /// This function issues a new <i> node map writing command</i> to the writer.
deba@1421:     template <typename Map>
deba@1421:     UndirGraphWriter& writeNodeMap(std::string name, const Map& map) {
deba@1421:       nodeset_writer.writeNodeMap(name, map);
deba@1421:       return *this;
deba@1421:     }
deba@1421: 
athos@1526:     /// \brief Issue a new node map writing command to the writer.
deba@1421:     ///
athos@1526:    /// This function issues a new <i> node map writing command</i> to the writer.
deba@1421:     template <typename Writer, typename Map>
deba@1421:     UndirGraphWriter& writeNodeMap(std::string name, const Map& map, 
deba@1421: 			      const Writer& writer = Writer()) {
deba@1421:       nodeset_writer.writeNodeMap(name, map, writer);
deba@1421:       return *this;
deba@1421:     }
deba@1421: 
athos@1526:     /// \brief Issue a new edge map writing command to the writer.
deba@1421:     ///
athos@1526:    /// This function issues a new <i> edge map writing command</i> to the writer.
deba@1421:     template <typename Map>
deba@1421:     UndirGraphWriter& writeEdgeMap(std::string name, const Map& map) { 
deba@1421:       undir_edgeset_writer.writeEdgeMap(name, map);
deba@1421:       return *this;
deba@1421:     }
deba@1421: 
athos@1526:     /// \brief Issue a new edge map writing command to the writer.
deba@1421:     ///
athos@1526:    /// This function issues a new <i> edge map writing command</i> to the writer.
deba@1421:     template <typename Writer, typename Map>
deba@1421:     UndirGraphWriter& writeEdgeMap(std::string name, const Map& map,
deba@1421: 				   const Writer& writer = Writer()) {
deba@1421:       undir_edgeset_writer.writeEdgeMap(name, map, writer);
deba@1421:       return *this;
deba@1421:     }
deba@1421: 
athos@1526:     /// \brief Issue a new undirected edge map writing command to the writer.
deba@1421:     ///
athos@1526:     /// This function issues a new <i> undirected edge map writing
athos@1526:     /// command</i> to the writer.
deba@1421:     template <typename Map>
deba@1421:     UndirGraphWriter& writeUndirEdgeMap(std::string name, const Map& map) { 
deba@1421:       undir_edgeset_writer.writeUndirEdgeMap(name, map);
deba@1421:       return *this;
deba@1421:     }
deba@1421: 
athos@1526:     /// \brief Issue a new undirected edge map writing command to the writer.
deba@1421:     ///
athos@1526:     /// This function issues a new <i> undirected edge map writing
athos@1526:     /// command</i> to the writer.
deba@1421:     template <typename Writer, typename Map>
deba@1421:     UndirGraphWriter& writeUndirEdgeMap(std::string name, const Map& map,
deba@1421: 					const Writer& writer = Writer()) {
deba@1421:       undir_edgeset_writer.writeUndirEdgeMap(name, map, writer);
deba@1421:       return *this;
deba@1421:     }
deba@1421: 
athos@1526:     /// \brief Issue a new labeled node writer to the writer.
deba@1421:     ///
athos@1526:     /// This function issues a new <i> labeled node writing
athos@1526:     /// command</i> to the writer.
deba@1421:     UndirGraphWriter& writeNode(std::string name, const Node& node) {
deba@1421:       node_writer.writeNode(name, node);
deba@1421:       return *this;
deba@1421:     }
deba@1421: 
athos@1526:     /// \brief Issue a new labeled edge writer to the writer.
deba@1421:     ///
athos@1526:     /// This function issues a new <i> labeled edge writing
athos@1526:     /// command</i> to the writer.
deba@1429:     UndirGraphWriter& writeEdge(std::string name, const Edge& edge) {
deba@1429:       undir_edge_writer.writeEdge(name, edge);
deba@1429:     }
deba@1429: 
athos@1526:     /// \brief Issue a new labeled undirected edge writing command to
athos@1526:     /// the writer.
deba@1429:     ///
athos@1526:     /// Issue a new <i>labeled undirected edge writing command</i> to
athos@1526:     /// the writer.
deba@1421:     UndirGraphWriter& writeUndirEdge(std::string name, const UndirEdge& edge) {
deba@1421:       undir_edge_writer.writeUndirEdge(name, edge);
deba@1421:     }
deba@1421: 
athos@1526:     /// \brief Issue a new attribute writing command.
deba@1421:     ///
athos@1526:     /// This function issues a new <i> attribute writing
athos@1526:     /// command</i> to the writer.
deba@1421:     template <typename Value>
deba@1421:     UndirGraphWriter& writeAttribute(std::string name, const Value& value) {
deba@1421:       attribute_writer.writeAttribute(name, value);
deba@1421:       return *this;
deba@1421:     }
deba@1421:     
athos@1526:     /// \brief Issue a new attribute writing command.
deba@1421:     ///
athos@1526:     /// This function issues a new <i> attribute writing
athos@1526:     /// command</i> to the writer.
deba@1421:     template <typename Writer, typename Value>
deba@1421:     UndirGraphWriter& writeAttribute(std::string name, const Value& value, 
deba@1421: 			       const Writer& writer) {
deba@1421:       attribute_writer.writeAttribute<Writer>(name, value, writer);
deba@1421:       return *this;
deba@1421:     }
deba@1421: 
deba@1421:     /// \brief Conversion operator to LemonWriter.
deba@1421:     ///
athos@1526:     /// Conversion operator to LemonWriter. It makes possible
deba@1421:     /// to access the encapsulated \e LemonWriter, this way
deba@1421:     /// you can attach to this writer new instances of 
deba@1421:     /// \e LemonWriter::SectionWriter.
deba@1421:     operator LemonWriter&() {
deba@1421:       return *writer;
deba@1421:     }
deba@1421: 
athos@1526:     /// \brief Executes the writing commands.
deba@1421:     ///
athos@1526:     /// Executes the writing commands.
deba@1421:     void run() {
deba@1421:       writer->run();
deba@1421:     }
deba@1421: 
deba@1429:     /// \brief Write the id of the given node.
deba@1429:     ///
deba@1429:     /// It writes the id of the given node. If there was written an "id"
athos@1526:     /// named node map then it will write the map value belonging to the node.
deba@1429:     void writeId(std::ostream& os, const Node& item) const {
deba@1429:       nodeset_writer.writeId(os, item);
deba@1429:     } 
deba@1429: 
deba@1429:     /// \brief Write the id of the given edge.
deba@1429:     ///
deba@1429:     /// It writes the id of the given edge. If there was written an "id"
athos@1526:     /// named edge map then it will write the map value belonging to the edge.
deba@1429:     void writeId(std::ostream& os, const Edge& item) const {
deba@1429:       undir_edgeset_writer.writeId(os, item);
deba@1429:     } 
deba@1429: 
deba@1429:     /// \brief Write the id of the given undirected edge.
deba@1429:     ///
deba@1429:     /// It writes the id of the given undirected edge. If there was written 
athos@1526:     /// an "id" named edge map then it will write the map value belonging to 
deba@1429:     /// the edge.
deba@1429:     void writeId(std::ostream& os, const UndirEdge& item) const {
deba@1429:       undir_edgeset_writer.writeId(os, item);
deba@1429:     } 
deba@1429: 
deba@1429: 
deba@1421:   private:
deba@1421: 
deba@1421:     LemonWriter* writer;
deba@1421:     bool own_writer;
deba@1421: 
deba@1421:     NodeSetWriter<Graph, WriterTraits> nodeset_writer;
deba@1421:     UndirEdgeSetWriter<Graph, WriterTraits> undir_edgeset_writer;
deba@1421: 
deba@1421:     NodeWriter<Graph> node_writer;
deba@1421:     UndirEdgeWriter<Graph> undir_edge_writer;
deba@1421:     
deba@1421:     AttributeWriter<WriterTraits> attribute_writer;
deba@1421:   };
deba@1421: 
deba@1421: 
athos@1526:   /// \brief Write an undirected multigraph (undirected graph + capacity
athos@1526:   /// map on the edges) to the output.
deba@1421:   ///
athos@1526:   /// Write an undirected multigraph (undirected graph + capacity
athos@1526:   /// map on the edges) to the output.
deba@1421:   /// \param os The output stream.
deba@1421:   /// \param g The graph.
deba@1421:   /// \param capacity The capacity undirected map.
deba@1421:   template<typename Graph, typename CapacityMap>
deba@1421:   void writeUndirGraph(std::ostream& os, const Graph &g, 
deba@1421: 		       const CapacityMap& capacity) {
deba@1421:     UndirGraphWriter<Graph> writer(os, g);
deba@1421:     writer.writeUndirEdgeMap("capacity", capacity);
deba@1421:     writer.run();
deba@1421:   }
deba@1421: 
deba@1421:   /// \brief Write an undirected graph to the output.
deba@1421:   ///
deba@1421:   /// Write an undirected graph to the output.
deba@1421:   /// \param os The output stream.
deba@1421:   /// \param g The graph.
deba@1421:   template<typename Graph>
deba@1421:   void writeUndirGraph(std::ostream& os, const Graph &g) {
deba@1421:     UndirGraphWriter<Graph> writer(os, g);
deba@1421:     writer.run();
deba@1421:   }
deba@1421: 
deba@1333:   /// @}
deba@1137: 
deba@1137: }
deba@1214: 
deba@1214: #endif