RhodeCode

  /// member function. A map reading rule can be added to the reader

  /// with the \c nodeMap() or \c arcMap() members. An optional

  /// converter parameter can also be added as a standard functor

  /// converting from std::string to the value type of the map. If it

  /// is set, it will determine how the tokens in the file should be

  /// is converted to the map's value type. If the functor is not set,

  /// then a default conversion will be used. One map can be read into

  /// multiple map objects at the same time. The \c attribute(), \c

  /// node() and \c arc() functions are used to add attribute reading

  /// rules.

  ///

  ///\code

  ///     DigraphReader<Digraph>(std::cin, digraph).

  ///       nodeMap("coordinates", coord_map).

  ///       arcMap("capacity", cap_map).

  ///       node("source", src).

  ///       node("target", trg).

  ///       attribute("caption", caption).

  ///       run();

  ///\endcode

  ///

  /// By default the reader uses the first section in the file of the

  /// proper type. If a section has an optional name, then it can be

  /// selected for reading by giving an optional name parameter to the

  ///

  /// The \c useNodes() and \c useArcs() functions are used to tell the reader

  /// that the nodes or arcs should not be constructed (added to the

  /// graph) during the reading, but instead the label map of the items

  /// are given as a parameter of these functions. An

  /// application of these function is multipass reading, which is

  /// important if two \e \@arcs sections must be read from the

  /// file. In this example the first phase would read the node set and one

  /// of the arc sets, while the second phase would read the second arc

  /// set into an \e ArcSet class (\c SmartArcSet or \c ListArcSet).

  /// The previously read label node map should be passed to the \c

  /// useNodes() functions. Another application of multipass reading when

  /// paths are given as a node map or an arc map. It is impossible read this in

  /// a single pass, because the arcs are not constructed when the node

  /// maps are read.

  template <typename _Digraph>

  class DigraphReader {

  public:

    typedef _Digraph Digraph;

    TEMPLATE_DIGRAPH_TYPEDEFS(Digraph);

  private:

    Digraph& _digraph;

    std::string _nodes_caption;

    std::string _arcs_caption;

    std::string _attributes_caption;

    typedef std::map<std::string, Node> NodeIndex;

    NodeIndex _node_index;

    typedef std::map<std::string, Arc> ArcIndex;

    ArcIndex _arc_index;

    typedef std::vector<std::pair<std::string, 

      _reader_bits::MapStorageBase<Node>*> > NodeMaps;    

    NodeMaps _node_maps; 

    typedef std::vector<std::pair<std::string,

      _reader_bits::MapStorageBase<Arc>*> >ArcMaps;

    ArcMaps _arc_maps;

    typedef std::multimap<std::string, _reader_bits::ValueStorageBase*> 

      Attributes;

    Attributes _attributes;

    bool _use_nodes;

    bool _use_arcs;

    bool _skip_nodes;

    bool _skip_arcs;

    int line_num;

    std::istringstream line;

  public:

    /// \brief Constructor

    ///

    /// Construct a directed graph reader, which reads from the given

    /// input stream.

    DigraphReader(std::istream& is, Digraph& digraph) 

      : _is(&is), local_is(false), _digraph(digraph),

	_use_nodes(false), _use_arcs(false),

	_skip_nodes(false), _skip_arcs(false) {}

    /// \brief Constructor

    ///

    /// Construct a directed graph reader, which reads from the given

    /// file.

    /// \brief Copy constructor

    ///

    /// The copy constructor transfers all data from the other reader,

    /// therefore the copied reader will not be usable more. 

    DigraphReader(DigraphReader& other) 

      : _is(other._is), local_is(other.local_is), _digraph(other._digraph),

	_use_nodes(other._use_nodes), _use_arcs(other._use_arcs),

	_skip_nodes(other._skip_nodes), _skip_arcs(other._skip_arcs) {

      other._is = 0;

      other.local_is = false;

      _node_index.swap(other._node_index);

      _arc_index.swap(other._arc_index);

      _node_maps.swap(other._node_maps);

      _arc_maps.swap(other._arc_maps);

      _attributes.swap(other._attributes);

      _nodes_caption = other._nodes_caption;

      _arcs_caption = other._arcs_caption;

      _attributes_caption = other._attributes_caption;

    }

    /// \brief Destructor

    ~DigraphReader() {

      for (typename NodeMaps::iterator it = _node_maps.begin(); 

	   it != _node_maps.end(); ++it) {

	delete it->second;

      }

      for (typename ArcMaps::iterator it = _arc_maps.begin(); 

	   it != _arc_maps.end(); ++it) {

	delete it->second;

      }

      for (typename Attributes::iterator it = _attributes.begin(); 

	   it != _attributes.end(); ++it) {

	delete it->second;

      }

      if (local_is) {

	delete _is;

      }

    }

  private:

    DigraphReader& operator=(const DigraphReader&);

  public:

    /// \name Reading rules

    /// @{

    /// \brief Node map reading rule

    ///

    /// Add a node map reading rule to the reader.

    template <typename Map>

    DigraphReader& nodeMap(const std::string& caption, Map& map) {

      checkConcept<concepts::WriteMap<Node, typename Map::Value>, Map>();

      _reader_bits::MapStorageBase<Node>* storage = 

	new _reader_bits::MapStorage<Node, Map>(map);

      _node_maps.push_back(std::make_pair(caption, storage));

    /// Set \c \@nodes section to be read

    DigraphReader& nodes(const std::string& caption) {

      _nodes_caption = caption;

      return *this;

    }

    /// \brief Set \c \@arcs section to be read

    ///

    /// Set \c \@arcs section to be read

    DigraphReader& arcs(const std::string& caption) {

      _arcs_caption = caption;

      return *this;

    }

    /// \brief Set \c \@attributes section to be read

    ///

    /// Set \c \@attributes section to be read

    DigraphReader& attributes(const std::string& caption) {

      _attributes_caption = caption;

      return *this;

    }

    /// @}

    /// \name Using previously constructed node or arc set

    /// @{

    /// \brief Use previously constructed node set

    ///

    /// Use previously constructed node set, and specify the node

    /// label map.

    template <typename Map>

    DigraphReader& useNodes(const Map& map) {

      checkConcept<concepts::ReadMap<Node, typename Map::Value>, Map>();

      LEMON_ASSERT(!_use_nodes, "Multiple usage of useNodes() member"); 

      _use_nodes = true;

      _writer_bits::DefaultConverter<typename Map::Value> converter;

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

	_node_index.insert(std::make_pair(converter(map[n]), n));

      }

      return *this;

    }

    /// \brief Use previously constructed node set

    ///

    /// Use previously constructed node set, and specify the node

    /// label map and a functor which converts the label map values to

    /// std::string.

	  std::ostringstream msg;

	  msg << "Attribute not found in file: " << it->first;

	  throw DataFormatError(msg.str().c_str());

	}	

      }

    }

  public:

    /// \name Execution of the reader    

    /// @{

    /// \brief Start the batch processing

    ///

    /// This function starts the batch processing

    void run() {

      LEMON_ASSERT(_is != 0, "This reader assigned to an other reader");

      if (!*_is) {

	throw DataFormatError("Cannot find file");

      }

      bool nodes_done = _skip_nodes;

      bool arcs_done = _skip_arcs;

      bool attributes_done = false;

      line_num = 0;      

      readLine();

      skipSection();

      while (readSuccess()) {

	try {

	  char c;

	  std::string section, caption;

	  line >> c;

	  _reader_bits::readToken(line, section);

	  _reader_bits::readToken(line, caption);

	  if (line >> c) 

	    throw DataFormatError("Extra character on the end of line");

	  if (section == "nodes" && !nodes_done) {

	    if (_nodes_caption.empty() || _nodes_caption == caption) {

	      readNodes();

	      nodes_done = true;

	    }

	  } else if ((section == "arcs" || section == "edges") && 

		     !arcs_done) {

	    if (_arcs_caption.empty() || _arcs_caption == caption) {

	      readArcs();

	      arcs_done = true;

	    }

	  } else if (section == "attributes" && !attributes_done) {

	    if (_attributes_caption.empty() || _attributes_caption == caption) {

	      readAttributes();

	      attributes_done = true;

	    }

	  } else {

	    readLine();

	    skipSection();

	  }

	} catch (DataFormatError& error) {

	  error.line(line_num);

	  throw;

	}	

      }

      if (!nodes_done) {

	throw DataFormatError("Section @nodes not found");

      }

      if (!arcs_done) {

	throw DataFormatError("Section @arcs not found");

      }

      if (!attributes_done && !_attributes.empty()) {

	throw DataFormatError("Section @attributes not found");

      }

    }

    /// @}

    return tmp;

  }

  /// \relates DigraphReader

  template <typename Digraph>

  DigraphReader<Digraph> digraphReader(const char* fn, Digraph& digraph) {

    DigraphReader<Digraph> tmp(fn, digraph);

    return tmp;

  }

  /// \ingroup lemon_io

  ///  

  /// \brief LGF reader for undirected graphs

  ///

  /// This utility reads an \ref lgf-format "LGF" file.

  template <typename _Graph>

  class GraphReader {

  public:

    typedef _Graph Graph;

    TEMPLATE_GRAPH_TYPEDEFS(Graph);

  private:

    std::istream* _is;

    bool local_is;

    Graph& _graph;

    std::string _nodes_caption;

    std::string _edges_caption;

    std::string _attributes_caption;

    typedef std::map<std::string, Node> NodeIndex;

    NodeIndex _node_index;

    typedef std::map<std::string, Edge> EdgeIndex;

    EdgeIndex _edge_index;

    typedef std::vector<std::pair<std::string, 

      _reader_bits::MapStorageBase<Node>*> > NodeMaps;    

    NodeMaps _node_maps; 

    typedef std::vector<std::pair<std::string,

      _reader_bits::MapStorageBase<Edge>*> > EdgeMaps;

    EdgeMaps _edge_maps;

    typedef std::multimap<std::string, _reader_bits::ValueStorageBase*> 

      Attributes;

    Attributes _attributes;

    bool _use_nodes;

    bool _use_edges;

    bool _skip_nodes;

    bool _skip_edges;

    int line_num;

    std::istringstream line;

  public:

    /// \brief Constructor

    ///

    /// Construct a undirected graph reader, which reads from the given

    /// input stream.

    GraphReader(std::istream& is, Graph& graph) 

      : _is(&is), local_is(false), _graph(graph),

	_use_nodes(false), _use_edges(false),

	_skip_nodes(false), _skip_edges(false) {}

    /// \brief Constructor

    ///

    /// Construct a undirected graph reader, which reads from the given

    /// file.

    /// \brief Copy constructor

    ///

    /// The copy constructor transfers all data from the other reader,

    /// therefore the copied reader will not be usable more. 

    GraphReader(GraphReader& other) 

      : _is(other._is), local_is(other.local_is), _graph(other._graph),

	_use_nodes(other._use_nodes), _use_edges(other._use_edges),

	_skip_nodes(other._skip_nodes), _skip_edges(other._skip_edges) {

      other._is = 0;

      other.local_is = false;

      _node_index.swap(other._node_index);

      _edge_index.swap(other._edge_index);

      _node_maps.swap(other._node_maps);

      _edge_maps.swap(other._edge_maps);

      _attributes.swap(other._attributes);

      _nodes_caption = other._nodes_caption;

      _edges_caption = other._edges_caption;

      _attributes_caption = other._attributes_caption;

    }

    /// \brief Destructor

    ~GraphReader() {

      for (typename NodeMaps::iterator it = _node_maps.begin(); 

	   it != _node_maps.end(); ++it) {

	delete it->second;

      }

      for (typename EdgeMaps::iterator it = _edge_maps.begin(); 

	   it != _edge_maps.end(); ++it) {

	delete it->second;

      }

      for (typename Attributes::iterator it = _attributes.begin(); 

	   it != _attributes.end(); ++it) {

	delete it->second;

      }

      if (local_is) {

	delete _is;

      }

    }

  private:

    GraphReader& operator=(const GraphReader&);

  public:

    /// \name Reading rules

    /// @{

    /// \brief Node map reading rule

    ///

    /// Add a node map reading rule to the reader.

    template <typename Map>

    GraphReader& nodeMap(const std::string& caption, Map& map) {

      checkConcept<concepts::WriteMap<Node, typename Map::Value>, Map>();

      _reader_bits::MapStorageBase<Node>* storage = 

	new _reader_bits::MapStorage<Node, Map>(map);

      _node_maps.push_back(std::make_pair(caption, storage));

    /// Set \c \@nodes section to be read

    GraphReader& nodes(const std::string& caption) {

      _nodes_caption = caption;

      return *this;

    }

    /// \brief Set \c \@edges section to be read

    ///

    /// Set \c \@edges section to be read

    GraphReader& edges(const std::string& caption) {

      _edges_caption = caption;

      return *this;

    }

    /// \brief Set \c \@attributes section to be read

    ///

    /// Set \c \@attributes section to be read

    GraphReader& attributes(const std::string& caption) {

      _attributes_caption = caption;

      return *this;

    }

    /// @}

    /// \name Using previously constructed node or edge set

    /// @{

    /// \brief Use previously constructed node set

    ///

    /// Use previously constructed node set, and specify the node

    /// label map.

    template <typename Map>

    GraphReader& useNodes(const Map& map) {

      checkConcept<concepts::ReadMap<Node, typename Map::Value>, Map>();

      LEMON_ASSERT(!_use_nodes, "Multiple usage of useNodes() member"); 

      _use_nodes = true;

      _writer_bits::DefaultConverter<typename Map::Value> converter;

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

	_node_index.insert(std::make_pair(converter(map[n]), n));

      }

      return *this;

    }

    /// \brief Use previously constructed node set

    ///

    /// Use previously constructed node set, and specify the node

    /// label map and a functor which converts the label map values to

    /// std::string.

	   it != _attributes.end(); ++it) {

	if (read_attr.find(it->first) == read_attr.end()) {

	  std::ostringstream msg;

	  msg << "Attribute not found in file: " << it->first;

	  throw DataFormatError(msg.str().c_str());

	}	

      }

    }

  public:

    /// \name Execution of the reader    

    /// @{

    /// \brief Start the batch processing

    ///

    /// This function starts the batch processing

    void run() {

      LEMON_ASSERT(_is != 0, "This reader assigned to an other reader");

      bool nodes_done = _skip_nodes;

      bool edges_done = _skip_edges;

      bool attributes_done = false;

      line_num = 0;      

      readLine();

      skipSection();

      while (readSuccess()) {

	try {

	  char c;

	  std::string section, caption;

	  line >> c;

	  _reader_bits::readToken(line, section);

	  _reader_bits::readToken(line, caption);

	  if (line >> c) 

	    throw DataFormatError("Extra character on the end of line");

	  if (section == "nodes" && !nodes_done) {

	    if (_nodes_caption.empty() || _nodes_caption == caption) {

	      readNodes();

	      nodes_done = true;

	    }

	  } else if ((section == "edges" || section == "arcs") && 

		     !edges_done) {

	    if (_edges_caption.empty() || _edges_caption == caption) {

	      readEdges();

	      edges_done = true;

	    }

	  } else if (section == "attributes" && !attributes_done) {

	    if (_attributes_caption.empty() || _attributes_caption == caption) {

	      readAttributes();

	      attributes_done = true;

	    }

	  } else {

	    readLine();

	    skipSection();

	  }

	} catch (DataFormatError& error) {

	  error.line(line_num);

	  throw;

	}	

      }

      if (!nodes_done) {

	throw DataFormatError("Section @nodes not found");

      }

      if (!edges_done) {

	throw DataFormatError("Section @edges not found");

      }

      if (!attributes_done && !_attributes.empty()) {

	throw DataFormatError("Section @attributes not found");

      }

    }

    /// @}

  };

  /// \relates GraphReader

  template <typename Graph>

  GraphReader<Graph> graphReader(std::istream& is, Graph& graph) {

    GraphReader<Graph> tmp(is, graph);

    return tmp;

  }

  /// \relates GraphReader

  template <typename Graph>

  GraphReader<Graph> graphReader(const std::string& fn, 

				       Graph& graph) {

    GraphReader<Graph> tmp(fn, graph);

    return tmp;

  }

  /// \relates GraphReader

  template <typename Graph>

  GraphReader<Graph> graphReader(const char* fn, Graph& graph) {

    GraphReader<Graph> tmp(fn, graph);

    return tmp;

  }

  /// \ingroup lemon_io

  ///

  /// \brief Reader for the contents of the \ref lgf-format "LGF" file 

  ///

  /// This class can be used to read the sections, the map names and

  /// the attributes from a file. Usually, the Lemon programs know

  /// that, which type of graph, which maps and which attributes

  /// should be read from a file, but in general tools (like glemon)

  /// the contents of an LGF file should be guessed somehow. This class

  /// reads the graph and stores the appropriate information for

  /// reading the graph.

  ///

  ///\code LgfContents contents("graph.lgf"); 

  /// contents.run();

  ///

  /// // does it contain any node section and arc section

  /// if (contents.nodeSectionNum() == 0 || contents.arcSectionNum()) {

  ///   std::cerr << "Failure, cannot find graph" << std::endl;

  ///   return -1;

  /// }

  /// std::cout << "The name of the default node section : " 

  ///           << contents.nodeSection(0) << std::endl;

  /// std::cout << "The number of the arc maps : " 

  ///           << contents.arcMaps(0).size() << std::endl;