1 /* -*- mode: C++; indent-tabs-mode: nil; -*-
3 * This file is a part of LEMON, a generic C++ optimization library.
5 * Copyright (C) 2003-2008
6 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
7 * (Egervary Research Group on Combinatorial Optimization, EGRES).
9 * Permission to use, modify and distribute this software is granted
10 * provided that this copyright notice appears in all copies. For
11 * precise terms see the accompanying LICENSE file.
13 * This software is provided "AS IS" with no warranty of any kind,
14 * express or implied, and with no claim as to its suitability for any
21 ///\brief \ref lgf-format "LEMON Graph Format" reader.
24 #ifndef LEMON_LGF_READER_H
25 #define LEMON_LGF_READER_H
34 #include <lemon/core.h>
36 #include <lemon/lgf_writer.h>
38 #include <lemon/concept_check.h>
39 #include <lemon/concepts/maps.h>
43 namespace _reader_bits {
45 template <typename Value>
46 struct DefaultConverter {
47 Value operator()(const std::string& str) {
48 std::istringstream is(str);
51 throw FormatError("Cannot read token");
55 if (is >> std::ws >> c) {
56 throw FormatError("Remaining characters in token");
63 struct DefaultConverter<std::string> {
64 std::string operator()(const std::string& str) {
69 template <typename _Item>
70 class MapStorageBase {
76 virtual ~MapStorageBase() {}
78 virtual void set(const Item& item, const std::string& value) = 0;
82 template <typename _Item, typename _Map,
83 typename _Converter = DefaultConverter<typename _Map::Value> >
84 class MapStorage : public MapStorageBase<_Item> {
87 typedef _Converter Converter;
95 MapStorage(Map& map, const Converter& converter = Converter())
96 : _map(map), _converter(converter) {}
97 virtual ~MapStorage() {}
99 virtual void set(const Item& item ,const std::string& value) {
100 _map.set(item, _converter(value));
104 template <typename _Graph, bool _dir, typename _Map,
105 typename _Converter = DefaultConverter<typename _Map::Value> >
106 class GraphArcMapStorage : public MapStorageBase<typename _Graph::Edge> {
109 typedef _Converter Converter;
110 typedef _Graph Graph;
111 typedef typename Graph::Edge Item;
112 static const bool dir = _dir;
117 Converter _converter;
120 GraphArcMapStorage(const Graph& graph, Map& map,
121 const Converter& converter = Converter())
122 : _graph(graph), _map(map), _converter(converter) {}
123 virtual ~GraphArcMapStorage() {}
125 virtual void set(const Item& item ,const std::string& value) {
126 _map.set(_graph.direct(item, dir), _converter(value));
130 class ValueStorageBase {
132 ValueStorageBase() {}
133 virtual ~ValueStorageBase() {}
135 virtual void set(const std::string&) = 0;
138 template <typename _Value, typename _Converter = DefaultConverter<_Value> >
139 class ValueStorage : public ValueStorageBase {
141 typedef _Value Value;
142 typedef _Converter Converter;
146 Converter _converter;
149 ValueStorage(Value& value, const Converter& converter = Converter())
150 : _value(value), _converter(converter) {}
152 virtual void set(const std::string& value) {
153 _value = _converter(value);
157 template <typename Value>
158 struct MapLookUpConverter {
159 const std::map<std::string, Value>& _map;
161 MapLookUpConverter(const std::map<std::string, Value>& map)
164 Value operator()(const std::string& str) {
165 typename std::map<std::string, Value>::const_iterator it =
167 if (it == _map.end()) {
168 std::ostringstream msg;
169 msg << "Item not found: " << str;
170 throw FormatError(msg.str());
176 template <typename Graph>
177 struct GraphArcLookUpConverter {
179 const std::map<std::string, typename Graph::Edge>& _map;
181 GraphArcLookUpConverter(const Graph& graph,
182 const std::map<std::string,
183 typename Graph::Edge>& map)
184 : _graph(graph), _map(map) {}
186 typename Graph::Arc operator()(const std::string& str) {
187 if (str.empty() || (str[0] != '+' && str[0] != '-')) {
188 throw FormatError("Item must start with '+' or '-'");
190 typename std::map<std::string, typename Graph::Edge>
191 ::const_iterator it = _map.find(str.substr(1));
192 if (it == _map.end()) {
193 throw FormatError("Item not found");
195 return _graph.direct(it->second, str[0] == '+');
199 inline bool isWhiteSpace(char c) {
200 return c == ' ' || c == '\t' || c == '\v' ||
201 c == '\n' || c == '\r' || c == '\f';
204 inline bool isOct(char c) {
205 return '0' <= c && c <='7';
208 inline int valueOct(char c) {
209 LEMON_ASSERT(isOct(c), "The character is not octal.");
213 inline bool isHex(char c) {
214 return ('0' <= c && c <= '9') ||
215 ('a' <= c && c <= 'z') ||
216 ('A' <= c && c <= 'Z');
219 inline int valueHex(char c) {
220 LEMON_ASSERT(isHex(c), "The character is not hexadecimal.");
221 if ('0' <= c && c <= '9') return c - '0';
222 if ('a' <= c && c <= 'z') return c - 'a' + 10;
226 inline bool isIdentifierFirstChar(char c) {
227 return ('a' <= c && c <= 'z') ||
228 ('A' <= c && c <= 'Z') || c == '_';
231 inline bool isIdentifierChar(char c) {
232 return isIdentifierFirstChar(c) ||
233 ('0' <= c && c <= '9');
236 inline char readEscape(std::istream& is) {
239 throw FormatError("Escape format error");
267 if (!is.get(c) || !isHex(c))
268 throw FormatError("Escape format error");
269 else if (code = valueHex(c), !is.get(c) || !isHex(c)) is.putback(c);
270 else code = code * 16 + valueHex(c);
277 throw FormatError("Escape format error");
278 else if (code = valueOct(c), !is.get(c) || !isOct(c))
280 else if (code = code * 8 + valueOct(c), !is.get(c) || !isOct(c))
282 else code = code * 8 + valueOct(c);
288 inline std::istream& readToken(std::istream& is, std::string& str) {
289 std::ostringstream os;
298 while (is.get(c) && c != '\"') {
304 throw FormatError("Quoted format error");
307 while (is.get(c) && !isWhiteSpace(c)) {
324 virtual ~Section() {}
325 virtual void process(std::istream& is, int& line_num) = 0;
328 template <typename Functor>
329 class LineSection : public Section {
336 LineSection(const Functor& functor) : _functor(functor) {}
337 virtual ~LineSection() {}
339 virtual void process(std::istream& is, int& line_num) {
342 while (is.get(c) && c != '@') {
345 } else if (c == '#') {
348 } else if (!isWhiteSpace(c)) {
355 if (is) is.putback(c);
356 else if (is.eof()) is.clear();
360 template <typename Functor>
361 class StreamSection : public Section {
368 StreamSection(const Functor& functor) : _functor(functor) {}
369 virtual ~StreamSection() {}
371 virtual void process(std::istream& is, int& line_num) {
372 _functor(is, line_num);
375 while (is.get(c) && c != '@') {
378 } else if (!isWhiteSpace(c)) {
383 if (is) is.putback(c);
384 else if (is.eof()) is.clear();
390 template <typename Digraph>
393 template <typename Digraph>
394 DigraphReader<Digraph> digraphReader(Digraph& digraph,
395 std::istream& is = std::cin);
396 template <typename Digraph>
397 DigraphReader<Digraph> digraphReader(Digraph& digraph, const std::string& fn);
398 template <typename Digraph>
399 DigraphReader<Digraph> digraphReader(Digraph& digraph, const char *fn);
401 /// \ingroup lemon_io
403 /// \brief \ref lgf-format "LGF" reader for directed graphs
405 /// This utility reads an \ref lgf-format "LGF" file.
407 /// The reading method does a batch processing. The user creates a
408 /// reader object, then various reading rules can be added to the
409 /// reader, and eventually the reading is executed with the \c run()
410 /// member function. A map reading rule can be added to the reader
411 /// with the \c nodeMap() or \c arcMap() members. An optional
412 /// converter parameter can also be added as a standard functor
413 /// converting from \c std::string to the value type of the map. If it
414 /// is set, it will determine how the tokens in the file should be
415 /// converted to the value type of the map. If the functor is not set,
416 /// then a default conversion will be used. One map can be read into
417 /// multiple map objects at the same time. The \c attribute(), \c
418 /// node() and \c arc() functions are used to add attribute reading
422 /// DigraphReader<Digraph>(digraph, std::cin).
423 /// nodeMap("coordinates", coord_map).
424 /// arcMap("capacity", cap_map).
425 /// node("source", src).
426 /// node("target", trg).
427 /// attribute("caption", caption).
431 /// By default the reader uses the first section in the file of the
432 /// proper type. If a section has an optional name, then it can be
433 /// selected for reading by giving an optional name parameter to the
434 /// \c nodes(), \c arcs() or \c attributes() functions.
436 /// The \c useNodes() and \c useArcs() functions are used to tell the reader
437 /// that the nodes or arcs should not be constructed (added to the
438 /// graph) during the reading, but instead the label map of the items
439 /// are given as a parameter of these functions. An
440 /// application of these functions is multipass reading, which is
441 /// important if two \c \@arcs sections must be read from the
442 /// file. In this case the first phase would read the node set and one
443 /// of the arc sets, while the second phase would read the second arc
444 /// set into an \e ArcSet class (\c SmartArcSet or \c ListArcSet).
445 /// The previously read label node map should be passed to the \c
446 /// useNodes() functions. Another application of multipass reading when
447 /// paths are given as a node map or an arc map.
448 /// It is impossible to read this in
449 /// a single pass, because the arcs are not constructed when the node
451 template <typename _Digraph>
452 class DigraphReader {
455 typedef _Digraph Digraph;
456 TEMPLATE_DIGRAPH_TYPEDEFS(Digraph);
463 std::string _filename;
467 std::string _nodes_caption;
468 std::string _arcs_caption;
469 std::string _attributes_caption;
471 typedef std::map<std::string, Node> NodeIndex;
472 NodeIndex _node_index;
473 typedef std::map<std::string, Arc> ArcIndex;
476 typedef std::vector<std::pair<std::string,
477 _reader_bits::MapStorageBase<Node>*> > NodeMaps;
480 typedef std::vector<std::pair<std::string,
481 _reader_bits::MapStorageBase<Arc>*> >ArcMaps;
484 typedef std::multimap<std::string, _reader_bits::ValueStorageBase*>
486 Attributes _attributes;
495 std::istringstream line;
499 /// \brief Constructor
501 /// Construct a directed graph reader, which reads from the given
503 DigraphReader(Digraph& digraph, std::istream& is = std::cin)
504 : _is(&is), local_is(false), _digraph(digraph),
505 _use_nodes(false), _use_arcs(false),
506 _skip_nodes(false), _skip_arcs(false) {}
508 /// \brief Constructor
510 /// Construct a directed graph reader, which reads from the given
512 DigraphReader(Digraph& digraph, const std::string& fn)
513 : _is(new std::ifstream(fn.c_str())), local_is(true),
514 _filename(fn), _digraph(digraph),
515 _use_nodes(false), _use_arcs(false),
516 _skip_nodes(false), _skip_arcs(false) {
519 throw IoError("Cannot open file", fn);
523 /// \brief Constructor
525 /// Construct a directed graph reader, which reads from the given
527 DigraphReader(Digraph& digraph, const char* fn)
528 : _is(new std::ifstream(fn)), local_is(true),
529 _filename(fn), _digraph(digraph),
530 _use_nodes(false), _use_arcs(false),
531 _skip_nodes(false), _skip_arcs(false) {
534 throw IoError("Cannot open file", fn);
538 /// \brief Destructor
540 for (typename NodeMaps::iterator it = _node_maps.begin();
541 it != _node_maps.end(); ++it) {
545 for (typename ArcMaps::iterator it = _arc_maps.begin();
546 it != _arc_maps.end(); ++it) {
550 for (typename Attributes::iterator it = _attributes.begin();
551 it != _attributes.end(); ++it) {
563 template <typename DGR>
564 friend DigraphReader<DGR> digraphReader(DGR& digraph, std::istream& is);
565 template <typename DGR>
566 friend DigraphReader<DGR> digraphReader(DGR& digraph,
567 const std::string& fn);
568 template <typename DGR>
569 friend DigraphReader<DGR> digraphReader(DGR& digraph, const char *fn);
571 DigraphReader(DigraphReader& other)
572 : _is(other._is), local_is(other.local_is), _digraph(other._digraph),
573 _use_nodes(other._use_nodes), _use_arcs(other._use_arcs),
574 _skip_nodes(other._skip_nodes), _skip_arcs(other._skip_arcs) {
577 other.local_is = false;
579 _node_index.swap(other._node_index);
580 _arc_index.swap(other._arc_index);
582 _node_maps.swap(other._node_maps);
583 _arc_maps.swap(other._arc_maps);
584 _attributes.swap(other._attributes);
586 _nodes_caption = other._nodes_caption;
587 _arcs_caption = other._arcs_caption;
588 _attributes_caption = other._attributes_caption;
592 DigraphReader& operator=(const DigraphReader&);
596 /// \name Reading rules
599 /// \brief Node map reading rule
601 /// Add a node map reading rule to the reader.
602 template <typename Map>
603 DigraphReader& nodeMap(const std::string& caption, Map& map) {
604 checkConcept<concepts::WriteMap<Node, typename Map::Value>, Map>();
605 _reader_bits::MapStorageBase<Node>* storage =
606 new _reader_bits::MapStorage<Node, Map>(map);
607 _node_maps.push_back(std::make_pair(caption, storage));
611 /// \brief Node map reading rule
613 /// Add a node map reading rule with specialized converter to the
615 template <typename Map, typename Converter>
616 DigraphReader& nodeMap(const std::string& caption, Map& map,
617 const Converter& converter = Converter()) {
618 checkConcept<concepts::WriteMap<Node, typename Map::Value>, Map>();
619 _reader_bits::MapStorageBase<Node>* storage =
620 new _reader_bits::MapStorage<Node, Map, Converter>(map, converter);
621 _node_maps.push_back(std::make_pair(caption, storage));
625 /// \brief Arc map reading rule
627 /// Add an arc map reading rule to the reader.
628 template <typename Map>
629 DigraphReader& arcMap(const std::string& caption, Map& map) {
630 checkConcept<concepts::WriteMap<Arc, typename Map::Value>, Map>();
631 _reader_bits::MapStorageBase<Arc>* storage =
632 new _reader_bits::MapStorage<Arc, Map>(map);
633 _arc_maps.push_back(std::make_pair(caption, storage));
637 /// \brief Arc map reading rule
639 /// Add an arc map reading rule with specialized converter to the
641 template <typename Map, typename Converter>
642 DigraphReader& arcMap(const std::string& caption, Map& map,
643 const Converter& converter = Converter()) {
644 checkConcept<concepts::WriteMap<Arc, typename Map::Value>, Map>();
645 _reader_bits::MapStorageBase<Arc>* storage =
646 new _reader_bits::MapStorage<Arc, Map, Converter>(map, converter);
647 _arc_maps.push_back(std::make_pair(caption, storage));
651 /// \brief Attribute reading rule
653 /// Add an attribute reading rule to the reader.
654 template <typename Value>
655 DigraphReader& attribute(const std::string& caption, Value& value) {
656 _reader_bits::ValueStorageBase* storage =
657 new _reader_bits::ValueStorage<Value>(value);
658 _attributes.insert(std::make_pair(caption, storage));
662 /// \brief Attribute reading rule
664 /// Add an attribute reading rule with specialized converter to the
666 template <typename Value, typename Converter>
667 DigraphReader& attribute(const std::string& caption, Value& value,
668 const Converter& converter = Converter()) {
669 _reader_bits::ValueStorageBase* storage =
670 new _reader_bits::ValueStorage<Value, Converter>(value, converter);
671 _attributes.insert(std::make_pair(caption, storage));
675 /// \brief Node reading rule
677 /// Add a node reading rule to reader.
678 DigraphReader& node(const std::string& caption, Node& node) {
679 typedef _reader_bits::MapLookUpConverter<Node> Converter;
680 Converter converter(_node_index);
681 _reader_bits::ValueStorageBase* storage =
682 new _reader_bits::ValueStorage<Node, Converter>(node, converter);
683 _attributes.insert(std::make_pair(caption, storage));
687 /// \brief Arc reading rule
689 /// Add an arc reading rule to reader.
690 DigraphReader& arc(const std::string& caption, Arc& arc) {
691 typedef _reader_bits::MapLookUpConverter<Arc> Converter;
692 Converter converter(_arc_index);
693 _reader_bits::ValueStorageBase* storage =
694 new _reader_bits::ValueStorage<Arc, Converter>(arc, converter);
695 _attributes.insert(std::make_pair(caption, storage));
701 /// \name Select section by name
704 /// \brief Set \c \@nodes section to be read
706 /// Set \c \@nodes section to be read
707 DigraphReader& nodes(const std::string& caption) {
708 _nodes_caption = caption;
712 /// \brief Set \c \@arcs section to be read
714 /// Set \c \@arcs section to be read
715 DigraphReader& arcs(const std::string& caption) {
716 _arcs_caption = caption;
720 /// \brief Set \c \@attributes section to be read
722 /// Set \c \@attributes section to be read
723 DigraphReader& attributes(const std::string& caption) {
724 _attributes_caption = caption;
730 /// \name Using previously constructed node or arc set
733 /// \brief Use previously constructed node set
735 /// Use previously constructed node set, and specify the node
737 template <typename Map>
738 DigraphReader& useNodes(const Map& map) {
739 checkConcept<concepts::ReadMap<Node, typename Map::Value>, Map>();
740 LEMON_ASSERT(!_use_nodes, "Multiple usage of useNodes() member");
742 _writer_bits::DefaultConverter<typename Map::Value> converter;
743 for (NodeIt n(_digraph); n != INVALID; ++n) {
744 _node_index.insert(std::make_pair(converter(map[n]), n));
749 /// \brief Use previously constructed node set
751 /// Use previously constructed node set, and specify the node
752 /// label map and a functor which converts the label map values to
754 template <typename Map, typename Converter>
755 DigraphReader& useNodes(const Map& map,
756 const Converter& converter = Converter()) {
757 checkConcept<concepts::ReadMap<Node, typename Map::Value>, Map>();
758 LEMON_ASSERT(!_use_nodes, "Multiple usage of useNodes() member");
760 for (NodeIt n(_digraph); n != INVALID; ++n) {
761 _node_index.insert(std::make_pair(converter(map[n]), n));
766 /// \brief Use previously constructed arc set
768 /// Use previously constructed arc set, and specify the arc
770 template <typename Map>
771 DigraphReader& useArcs(const Map& map) {
772 checkConcept<concepts::ReadMap<Arc, typename Map::Value>, Map>();
773 LEMON_ASSERT(!_use_arcs, "Multiple usage of useArcs() member");
775 _writer_bits::DefaultConverter<typename Map::Value> converter;
776 for (ArcIt a(_digraph); a != INVALID; ++a) {
777 _arc_index.insert(std::make_pair(converter(map[a]), a));
782 /// \brief Use previously constructed arc set
784 /// Use previously constructed arc set, and specify the arc
785 /// label map and a functor which converts the label map values to
787 template <typename Map, typename Converter>
788 DigraphReader& useArcs(const Map& map,
789 const Converter& converter = Converter()) {
790 checkConcept<concepts::ReadMap<Arc, typename Map::Value>, Map>();
791 LEMON_ASSERT(!_use_arcs, "Multiple usage of useArcs() member");
793 for (ArcIt a(_digraph); a != INVALID; ++a) {
794 _arc_index.insert(std::make_pair(converter(map[a]), a));
799 /// \brief Skips the reading of node section
801 /// Omit the reading of the node section. This implies that each node
802 /// map reading rule will be abandoned, and the nodes of the graph
803 /// will not be constructed, which usually cause that the arc set
804 /// could not be read due to lack of node name resolving.
805 /// Therefore \c skipArcs() function should also be used, or
806 /// \c useNodes() should be used to specify the label of the nodes.
807 DigraphReader& skipNodes() {
808 LEMON_ASSERT(!_skip_nodes, "Skip nodes already set");
813 /// \brief Skips the reading of arc section
815 /// Omit the reading of the arc section. This implies that each arc
816 /// map reading rule will be abandoned, and the arcs of the graph
817 /// will not be constructed.
818 DigraphReader& skipArcs() {
819 LEMON_ASSERT(!_skip_arcs, "Skip arcs already set");
830 while(++line_num, std::getline(*_is, str)) {
831 line.clear(); line.str(str);
833 if (line >> std::ws >> c && c != '#') {
842 return static_cast<bool>(*_is);
847 while (readSuccess() && line >> c && c != '@') {
855 std::vector<int> map_index(_node_maps.size());
856 int map_num, label_index;
859 if (!readLine() || !(line >> c) || c == '@') {
860 if (readSuccess() && line) line.putback(c);
861 if (!_node_maps.empty())
862 throw FormatError("Cannot find map names");
868 std::map<std::string, int> maps;
872 while (_reader_bits::readToken(line, map)) {
873 if (maps.find(map) != maps.end()) {
874 std::ostringstream msg;
875 msg << "Multiple occurence of node map: " << map;
876 throw FormatError(msg.str());
878 maps.insert(std::make_pair(map, index));
882 for (int i = 0; i < static_cast<int>(_node_maps.size()); ++i) {
883 std::map<std::string, int>::iterator jt =
884 maps.find(_node_maps[i].first);
885 if (jt == maps.end()) {
886 std::ostringstream msg;
887 msg << "Map not found: " << _node_maps[i].first;
888 throw FormatError(msg.str());
890 map_index[i] = jt->second;
894 std::map<std::string, int>::iterator jt = maps.find("label");
895 if (jt != maps.end()) {
896 label_index = jt->second;
901 map_num = maps.size();
904 while (readLine() && line >> c && c != '@') {
907 std::vector<std::string> tokens(map_num);
908 for (int i = 0; i < map_num; ++i) {
909 if (!_reader_bits::readToken(line, tokens[i])) {
910 std::ostringstream msg;
911 msg << "Column not found (" << i + 1 << ")";
912 throw FormatError(msg.str());
915 if (line >> std::ws >> c)
916 throw FormatError("Extra character at the end of line");
920 n = _digraph.addNode();
921 if (label_index != -1)
922 _node_index.insert(std::make_pair(tokens[label_index], n));
924 if (label_index == -1)
925 throw FormatError("Label map not found");
926 typename std::map<std::string, Node>::iterator it =
927 _node_index.find(tokens[label_index]);
928 if (it == _node_index.end()) {
929 std::ostringstream msg;
930 msg << "Node with label not found: " << tokens[label_index];
931 throw FormatError(msg.str());
936 for (int i = 0; i < static_cast<int>(_node_maps.size()); ++i) {
937 _node_maps[i].second->set(n, tokens[map_index[i]]);
948 std::vector<int> map_index(_arc_maps.size());
949 int map_num, label_index;
952 if (!readLine() || !(line >> c) || c == '@') {
953 if (readSuccess() && line) line.putback(c);
954 if (!_arc_maps.empty())
955 throw FormatError("Cannot find map names");
961 std::map<std::string, int> maps;
965 while (_reader_bits::readToken(line, map)) {
966 if (maps.find(map) != maps.end()) {
967 std::ostringstream msg;
968 msg << "Multiple occurence of arc map: " << map;
969 throw FormatError(msg.str());
971 maps.insert(std::make_pair(map, index));
975 for (int i = 0; i < static_cast<int>(_arc_maps.size()); ++i) {
976 std::map<std::string, int>::iterator jt =
977 maps.find(_arc_maps[i].first);
978 if (jt == maps.end()) {
979 std::ostringstream msg;
980 msg << "Map not found: " << _arc_maps[i].first;
981 throw FormatError(msg.str());
983 map_index[i] = jt->second;
987 std::map<std::string, int>::iterator jt = maps.find("label");
988 if (jt != maps.end()) {
989 label_index = jt->second;
994 map_num = maps.size();
997 while (readLine() && line >> c && c != '@') {
1000 std::string source_token;
1001 std::string target_token;
1003 if (!_reader_bits::readToken(line, source_token))
1004 throw FormatError("Source not found");
1006 if (!_reader_bits::readToken(line, target_token))
1007 throw FormatError("Target not found");
1009 std::vector<std::string> tokens(map_num);
1010 for (int i = 0; i < map_num; ++i) {
1011 if (!_reader_bits::readToken(line, tokens[i])) {
1012 std::ostringstream msg;
1013 msg << "Column not found (" << i + 1 << ")";
1014 throw FormatError(msg.str());
1017 if (line >> std::ws >> c)
1018 throw FormatError("Extra character at the end of line");
1023 typename NodeIndex::iterator it;
1025 it = _node_index.find(source_token);
1026 if (it == _node_index.end()) {
1027 std::ostringstream msg;
1028 msg << "Item not found: " << source_token;
1029 throw FormatError(msg.str());
1031 Node source = it->second;
1033 it = _node_index.find(target_token);
1034 if (it == _node_index.end()) {
1035 std::ostringstream msg;
1036 msg << "Item not found: " << target_token;
1037 throw FormatError(msg.str());
1039 Node target = it->second;
1041 a = _digraph.addArc(source, target);
1042 if (label_index != -1)
1043 _arc_index.insert(std::make_pair(tokens[label_index], a));
1045 if (label_index == -1)
1046 throw FormatError("Label map not found");
1047 typename std::map<std::string, Arc>::iterator it =
1048 _arc_index.find(tokens[label_index]);
1049 if (it == _arc_index.end()) {
1050 std::ostringstream msg;
1051 msg << "Arc with label not found: " << tokens[label_index];
1052 throw FormatError(msg.str());
1057 for (int i = 0; i < static_cast<int>(_arc_maps.size()); ++i) {
1058 _arc_maps[i].second->set(a, tokens[map_index[i]]);
1062 if (readSuccess()) {
1067 void readAttributes() {
1069 std::set<std::string> read_attr;
1072 while (readLine() && line >> c && c != '@') {
1075 std::string attr, token;
1076 if (!_reader_bits::readToken(line, attr))
1077 throw FormatError("Attribute name not found");
1078 if (!_reader_bits::readToken(line, token))
1079 throw FormatError("Attribute value not found");
1081 throw FormatError("Extra character at the end of line");
1084 std::set<std::string>::iterator it = read_attr.find(attr);
1085 if (it != read_attr.end()) {
1086 std::ostringstream msg;
1087 msg << "Multiple occurence of attribute: " << attr;
1088 throw FormatError(msg.str());
1090 read_attr.insert(attr);
1094 typename Attributes::iterator it = _attributes.lower_bound(attr);
1095 while (it != _attributes.end() && it->first == attr) {
1096 it->second->set(token);
1102 if (readSuccess()) {
1105 for (typename Attributes::iterator it = _attributes.begin();
1106 it != _attributes.end(); ++it) {
1107 if (read_attr.find(it->first) == read_attr.end()) {
1108 std::ostringstream msg;
1109 msg << "Attribute not found: " << it->first;
1110 throw FormatError(msg.str());
1117 /// \name Execution of the reader
1120 /// \brief Start the batch processing
1122 /// This function starts the batch processing
1124 LEMON_ASSERT(_is != 0, "This reader assigned to an other reader");
1126 bool nodes_done = _skip_nodes;
1127 bool arcs_done = _skip_arcs;
1128 bool attributes_done = false;
1134 while (readSuccess()) {
1137 std::string section, caption;
1139 _reader_bits::readToken(line, section);
1140 _reader_bits::readToken(line, caption);
1143 throw FormatError("Extra character at the end of line");
1145 if (section == "nodes" && !nodes_done) {
1146 if (_nodes_caption.empty() || _nodes_caption == caption) {
1150 } else if ((section == "arcs" || section == "edges") &&
1152 if (_arcs_caption.empty() || _arcs_caption == caption) {
1156 } else if (section == "attributes" && !attributes_done) {
1157 if (_attributes_caption.empty() || _attributes_caption == caption) {
1159 attributes_done = true;
1165 } catch (FormatError& error) {
1166 error.line(line_num);
1167 error.file(_filename);
1173 throw FormatError("Section @nodes not found");
1177 throw FormatError("Section @arcs not found");
1180 if (!attributes_done && !_attributes.empty()) {
1181 throw FormatError("Section @attributes not found");
1190 /// \brief Return a \ref DigraphReader class
1192 /// This function just returns a \ref DigraphReader class.
1193 /// \relates DigraphReader
1194 template <typename Digraph>
1195 DigraphReader<Digraph> digraphReader(Digraph& digraph, std::istream& is) {
1196 DigraphReader<Digraph> tmp(digraph, is);
1200 /// \brief Return a \ref DigraphReader class
1202 /// This function just returns a \ref DigraphReader class.
1203 /// \relates DigraphReader
1204 template <typename Digraph>
1205 DigraphReader<Digraph> digraphReader(Digraph& digraph,
1206 const std::string& fn) {
1207 DigraphReader<Digraph> tmp(digraph, fn);
1211 /// \brief Return a \ref DigraphReader class
1213 /// This function just returns a \ref DigraphReader class.
1214 /// \relates DigraphReader
1215 template <typename Digraph>
1216 DigraphReader<Digraph> digraphReader(Digraph& digraph, const char* fn) {
1217 DigraphReader<Digraph> tmp(digraph, fn);
1221 template <typename Graph>
1224 template <typename Graph>
1225 GraphReader<Graph> graphReader(Graph& graph,
1226 std::istream& is = std::cin);
1227 template <typename Graph>
1228 GraphReader<Graph> graphReader(Graph& graph, const std::string& fn);
1229 template <typename Graph>
1230 GraphReader<Graph> graphReader(Graph& graph, const char *fn);
1232 /// \ingroup lemon_io
1234 /// \brief \ref lgf-format "LGF" reader for undirected graphs
1236 /// This utility reads an \ref lgf-format "LGF" file.
1238 /// It can be used almost the same way as \c DigraphReader.
1239 /// The only difference is that this class can handle edges and
1240 /// edge maps as well as arcs and arc maps.
1242 /// The columns in the \c \@edges (or \c \@arcs) section are the
1243 /// edge maps. However, if there are two maps with the same name
1244 /// prefixed with \c '+' and \c '-', then these can be read into an
1245 /// arc map. Similarly, an attribute can be read into an arc, if
1246 /// it's value is an edge label prefixed with \c '+' or \c '-'.
1247 template <typename _Graph>
1251 typedef _Graph Graph;
1252 TEMPLATE_GRAPH_TYPEDEFS(Graph);
1258 std::string _filename;
1262 std::string _nodes_caption;
1263 std::string _edges_caption;
1264 std::string _attributes_caption;
1266 typedef std::map<std::string, Node> NodeIndex;
1267 NodeIndex _node_index;
1268 typedef std::map<std::string, Edge> EdgeIndex;
1269 EdgeIndex _edge_index;
1271 typedef std::vector<std::pair<std::string,
1272 _reader_bits::MapStorageBase<Node>*> > NodeMaps;
1273 NodeMaps _node_maps;
1275 typedef std::vector<std::pair<std::string,
1276 _reader_bits::MapStorageBase<Edge>*> > EdgeMaps;
1277 EdgeMaps _edge_maps;
1279 typedef std::multimap<std::string, _reader_bits::ValueStorageBase*>
1281 Attributes _attributes;
1290 std::istringstream line;
1294 /// \brief Constructor
1296 /// Construct an undirected graph reader, which reads from the given
1298 GraphReader(Graph& graph, std::istream& is = std::cin)
1299 : _is(&is), local_is(false), _graph(graph),
1300 _use_nodes(false), _use_edges(false),
1301 _skip_nodes(false), _skip_edges(false) {}
1303 /// \brief Constructor
1305 /// Construct an undirected graph reader, which reads from the given
1307 GraphReader(Graph& graph, const std::string& fn)
1308 : _is(new std::ifstream(fn.c_str())), local_is(true),
1309 _filename(fn), _graph(graph),
1310 _use_nodes(false), _use_edges(false),
1311 _skip_nodes(false), _skip_edges(false) {
1314 throw IoError("Cannot open file", fn);
1318 /// \brief Constructor
1320 /// Construct an undirected graph reader, which reads from the given
1322 GraphReader(Graph& graph, const char* fn)
1323 : _is(new std::ifstream(fn)), local_is(true),
1324 _filename(fn), _graph(graph),
1325 _use_nodes(false), _use_edges(false),
1326 _skip_nodes(false), _skip_edges(false) {
1329 throw IoError("Cannot open file", fn);
1333 /// \brief Destructor
1335 for (typename NodeMaps::iterator it = _node_maps.begin();
1336 it != _node_maps.end(); ++it) {
1340 for (typename EdgeMaps::iterator it = _edge_maps.begin();
1341 it != _edge_maps.end(); ++it) {
1345 for (typename Attributes::iterator it = _attributes.begin();
1346 it != _attributes.end(); ++it) {
1357 template <typename GR>
1358 friend GraphReader<GR> graphReader(GR& graph, std::istream& is);
1359 template <typename GR>
1360 friend GraphReader<GR> graphReader(GR& graph, const std::string& fn);
1361 template <typename GR>
1362 friend GraphReader<GR> graphReader(GR& graph, const char *fn);
1364 GraphReader(GraphReader& other)
1365 : _is(other._is), local_is(other.local_is), _graph(other._graph),
1366 _use_nodes(other._use_nodes), _use_edges(other._use_edges),
1367 _skip_nodes(other._skip_nodes), _skip_edges(other._skip_edges) {
1370 other.local_is = false;
1372 _node_index.swap(other._node_index);
1373 _edge_index.swap(other._edge_index);
1375 _node_maps.swap(other._node_maps);
1376 _edge_maps.swap(other._edge_maps);
1377 _attributes.swap(other._attributes);
1379 _nodes_caption = other._nodes_caption;
1380 _edges_caption = other._edges_caption;
1381 _attributes_caption = other._attributes_caption;
1385 GraphReader& operator=(const GraphReader&);
1389 /// \name Reading rules
1392 /// \brief Node map reading rule
1394 /// Add a node map reading rule to the reader.
1395 template <typename Map>
1396 GraphReader& nodeMap(const std::string& caption, Map& map) {
1397 checkConcept<concepts::WriteMap<Node, typename Map::Value>, Map>();
1398 _reader_bits::MapStorageBase<Node>* storage =
1399 new _reader_bits::MapStorage<Node, Map>(map);
1400 _node_maps.push_back(std::make_pair(caption, storage));
1404 /// \brief Node map reading rule
1406 /// Add a node map reading rule with specialized converter to the
1408 template <typename Map, typename Converter>
1409 GraphReader& nodeMap(const std::string& caption, Map& map,
1410 const Converter& converter = Converter()) {
1411 checkConcept<concepts::WriteMap<Node, typename Map::Value>, Map>();
1412 _reader_bits::MapStorageBase<Node>* storage =
1413 new _reader_bits::MapStorage<Node, Map, Converter>(map, converter);
1414 _node_maps.push_back(std::make_pair(caption, storage));
1418 /// \brief Edge map reading rule
1420 /// Add an edge map reading rule to the reader.
1421 template <typename Map>
1422 GraphReader& edgeMap(const std::string& caption, Map& map) {
1423 checkConcept<concepts::WriteMap<Edge, typename Map::Value>, Map>();
1424 _reader_bits::MapStorageBase<Edge>* storage =
1425 new _reader_bits::MapStorage<Edge, Map>(map);
1426 _edge_maps.push_back(std::make_pair(caption, storage));
1430 /// \brief Edge map reading rule
1432 /// Add an edge map reading rule with specialized converter to the
1434 template <typename Map, typename Converter>
1435 GraphReader& edgeMap(const std::string& caption, Map& map,
1436 const Converter& converter = Converter()) {
1437 checkConcept<concepts::WriteMap<Edge, typename Map::Value>, Map>();
1438 _reader_bits::MapStorageBase<Edge>* storage =
1439 new _reader_bits::MapStorage<Edge, Map, Converter>(map, converter);
1440 _edge_maps.push_back(std::make_pair(caption, storage));
1444 /// \brief Arc map reading rule
1446 /// Add an arc map reading rule to the reader.
1447 template <typename Map>
1448 GraphReader& arcMap(const std::string& caption, Map& map) {
1449 checkConcept<concepts::WriteMap<Arc, typename Map::Value>, Map>();
1450 _reader_bits::MapStorageBase<Edge>* forward_storage =
1451 new _reader_bits::GraphArcMapStorage<Graph, true, Map>(_graph, map);
1452 _edge_maps.push_back(std::make_pair('+' + caption, forward_storage));
1453 _reader_bits::MapStorageBase<Edge>* backward_storage =
1454 new _reader_bits::GraphArcMapStorage<Graph, false, Map>(_graph, map);
1455 _edge_maps.push_back(std::make_pair('-' + caption, backward_storage));
1459 /// \brief Arc map reading rule
1461 /// Add an arc map reading rule with specialized converter to the
1463 template <typename Map, typename Converter>
1464 GraphReader& arcMap(const std::string& caption, Map& map,
1465 const Converter& converter = Converter()) {
1466 checkConcept<concepts::WriteMap<Arc, typename Map::Value>, Map>();
1467 _reader_bits::MapStorageBase<Edge>* forward_storage =
1468 new _reader_bits::GraphArcMapStorage<Graph, true, Map, Converter>
1469 (_graph, map, converter);
1470 _edge_maps.push_back(std::make_pair('+' + caption, forward_storage));
1471 _reader_bits::MapStorageBase<Edge>* backward_storage =
1472 new _reader_bits::GraphArcMapStorage<Graph, false, Map, Converter>
1473 (_graph, map, converter);
1474 _edge_maps.push_back(std::make_pair('-' + caption, backward_storage));
1478 /// \brief Attribute reading rule
1480 /// Add an attribute reading rule to the reader.
1481 template <typename Value>
1482 GraphReader& attribute(const std::string& caption, Value& value) {
1483 _reader_bits::ValueStorageBase* storage =
1484 new _reader_bits::ValueStorage<Value>(value);
1485 _attributes.insert(std::make_pair(caption, storage));
1489 /// \brief Attribute reading rule
1491 /// Add an attribute reading rule with specialized converter to the
1493 template <typename Value, typename Converter>
1494 GraphReader& attribute(const std::string& caption, Value& value,
1495 const Converter& converter = Converter()) {
1496 _reader_bits::ValueStorageBase* storage =
1497 new _reader_bits::ValueStorage<Value, Converter>(value, converter);
1498 _attributes.insert(std::make_pair(caption, storage));
1502 /// \brief Node reading rule
1504 /// Add a node reading rule to reader.
1505 GraphReader& node(const std::string& caption, Node& node) {
1506 typedef _reader_bits::MapLookUpConverter<Node> Converter;
1507 Converter converter(_node_index);
1508 _reader_bits::ValueStorageBase* storage =
1509 new _reader_bits::ValueStorage<Node, Converter>(node, converter);
1510 _attributes.insert(std::make_pair(caption, storage));
1514 /// \brief Edge reading rule
1516 /// Add an edge reading rule to reader.
1517 GraphReader& edge(const std::string& caption, Edge& edge) {
1518 typedef _reader_bits::MapLookUpConverter<Edge> Converter;
1519 Converter converter(_edge_index);
1520 _reader_bits::ValueStorageBase* storage =
1521 new _reader_bits::ValueStorage<Edge, Converter>(edge, converter);
1522 _attributes.insert(std::make_pair(caption, storage));
1526 /// \brief Arc reading rule
1528 /// Add an arc reading rule to reader.
1529 GraphReader& arc(const std::string& caption, Arc& arc) {
1530 typedef _reader_bits::GraphArcLookUpConverter<Graph> Converter;
1531 Converter converter(_graph, _edge_index);
1532 _reader_bits::ValueStorageBase* storage =
1533 new _reader_bits::ValueStorage<Arc, Converter>(arc, converter);
1534 _attributes.insert(std::make_pair(caption, storage));
1540 /// \name Select section by name
1543 /// \brief Set \c \@nodes section to be read
1545 /// Set \c \@nodes section to be read.
1546 GraphReader& nodes(const std::string& caption) {
1547 _nodes_caption = caption;
1551 /// \brief Set \c \@edges section to be read
1553 /// Set \c \@edges section to be read.
1554 GraphReader& edges(const std::string& caption) {
1555 _edges_caption = caption;
1559 /// \brief Set \c \@attributes section to be read
1561 /// Set \c \@attributes section to be read.
1562 GraphReader& attributes(const std::string& caption) {
1563 _attributes_caption = caption;
1569 /// \name Using previously constructed node or edge set
1572 /// \brief Use previously constructed node set
1574 /// Use previously constructed node set, and specify the node
1576 template <typename Map>
1577 GraphReader& useNodes(const Map& map) {
1578 checkConcept<concepts::ReadMap<Node, typename Map::Value>, Map>();
1579 LEMON_ASSERT(!_use_nodes, "Multiple usage of useNodes() member");
1581 _writer_bits::DefaultConverter<typename Map::Value> converter;
1582 for (NodeIt n(_graph); n != INVALID; ++n) {
1583 _node_index.insert(std::make_pair(converter(map[n]), n));
1588 /// \brief Use previously constructed node set
1590 /// Use previously constructed node set, and specify the node
1591 /// label map and a functor which converts the label map values to
1593 template <typename Map, typename Converter>
1594 GraphReader& useNodes(const Map& map,
1595 const Converter& converter = Converter()) {
1596 checkConcept<concepts::ReadMap<Node, typename Map::Value>, Map>();
1597 LEMON_ASSERT(!_use_nodes, "Multiple usage of useNodes() member");
1599 for (NodeIt n(_graph); n != INVALID; ++n) {
1600 _node_index.insert(std::make_pair(converter(map[n]), n));
1605 /// \brief Use previously constructed edge set
1607 /// Use previously constructed edge set, and specify the edge
1609 template <typename Map>
1610 GraphReader& useEdges(const Map& map) {
1611 checkConcept<concepts::ReadMap<Edge, typename Map::Value>, Map>();
1612 LEMON_ASSERT(!_use_edges, "Multiple usage of useEdges() member");
1614 _writer_bits::DefaultConverter<typename Map::Value> converter;
1615 for (EdgeIt a(_graph); a != INVALID; ++a) {
1616 _edge_index.insert(std::make_pair(converter(map[a]), a));
1621 /// \brief Use previously constructed edge set
1623 /// Use previously constructed edge set, and specify the edge
1624 /// label map and a functor which converts the label map values to
1626 template <typename Map, typename Converter>
1627 GraphReader& useEdges(const Map& map,
1628 const Converter& converter = Converter()) {
1629 checkConcept<concepts::ReadMap<Edge, typename Map::Value>, Map>();
1630 LEMON_ASSERT(!_use_edges, "Multiple usage of useEdges() member");
1632 for (EdgeIt a(_graph); a != INVALID; ++a) {
1633 _edge_index.insert(std::make_pair(converter(map[a]), a));
1638 /// \brief Skip the reading of node section
1640 /// Omit the reading of the node section. This implies that each node
1641 /// map reading rule will be abandoned, and the nodes of the graph
1642 /// will not be constructed, which usually cause that the edge set
1643 /// could not be read due to lack of node name
1644 /// could not be read due to lack of node name resolving.
1645 /// Therefore \c skipEdges() function should also be used, or
1646 /// \c useNodes() should be used to specify the label of the nodes.
1647 GraphReader& skipNodes() {
1648 LEMON_ASSERT(!_skip_nodes, "Skip nodes already set");
1653 /// \brief Skip the reading of edge section
1655 /// Omit the reading of the edge section. This implies that each edge
1656 /// map reading rule will be abandoned, and the edges of the graph
1657 /// will not be constructed.
1658 GraphReader& skipEdges() {
1659 LEMON_ASSERT(!_skip_edges, "Skip edges already set");
1670 while(++line_num, std::getline(*_is, str)) {
1671 line.clear(); line.str(str);
1673 if (line >> std::ws >> c && c != '#') {
1681 bool readSuccess() {
1682 return static_cast<bool>(*_is);
1685 void skipSection() {
1687 while (readSuccess() && line >> c && c != '@') {
1695 std::vector<int> map_index(_node_maps.size());
1696 int map_num, label_index;
1699 if (!readLine() || !(line >> c) || c == '@') {
1700 if (readSuccess() && line) line.putback(c);
1701 if (!_node_maps.empty())
1702 throw FormatError("Cannot find map names");
1708 std::map<std::string, int> maps;
1712 while (_reader_bits::readToken(line, map)) {
1713 if (maps.find(map) != maps.end()) {
1714 std::ostringstream msg;
1715 msg << "Multiple occurence of node map: " << map;
1716 throw FormatError(msg.str());
1718 maps.insert(std::make_pair(map, index));
1722 for (int i = 0; i < static_cast<int>(_node_maps.size()); ++i) {
1723 std::map<std::string, int>::iterator jt =
1724 maps.find(_node_maps[i].first);
1725 if (jt == maps.end()) {
1726 std::ostringstream msg;
1727 msg << "Map not found: " << _node_maps[i].first;
1728 throw FormatError(msg.str());
1730 map_index[i] = jt->second;
1734 std::map<std::string, int>::iterator jt = maps.find("label");
1735 if (jt != maps.end()) {
1736 label_index = jt->second;
1741 map_num = maps.size();
1744 while (readLine() && line >> c && c != '@') {
1747 std::vector<std::string> tokens(map_num);
1748 for (int i = 0; i < map_num; ++i) {
1749 if (!_reader_bits::readToken(line, tokens[i])) {
1750 std::ostringstream msg;
1751 msg << "Column not found (" << i + 1 << ")";
1752 throw FormatError(msg.str());
1755 if (line >> std::ws >> c)
1756 throw FormatError("Extra character at the end of line");
1760 n = _graph.addNode();
1761 if (label_index != -1)
1762 _node_index.insert(std::make_pair(tokens[label_index], n));
1764 if (label_index == -1)
1765 throw FormatError("Label map not found");
1766 typename std::map<std::string, Node>::iterator it =
1767 _node_index.find(tokens[label_index]);
1768 if (it == _node_index.end()) {
1769 std::ostringstream msg;
1770 msg << "Node with label not found: " << tokens[label_index];
1771 throw FormatError(msg.str());
1776 for (int i = 0; i < static_cast<int>(_node_maps.size()); ++i) {
1777 _node_maps[i].second->set(n, tokens[map_index[i]]);
1781 if (readSuccess()) {
1788 std::vector<int> map_index(_edge_maps.size());
1789 int map_num, label_index;
1792 if (!readLine() || !(line >> c) || c == '@') {
1793 if (readSuccess() && line) line.putback(c);
1794 if (!_edge_maps.empty())
1795 throw FormatError("Cannot find map names");
1801 std::map<std::string, int> maps;
1805 while (_reader_bits::readToken(line, map)) {
1806 if (maps.find(map) != maps.end()) {
1807 std::ostringstream msg;
1808 msg << "Multiple occurence of edge map: " << map;
1809 throw FormatError(msg.str());
1811 maps.insert(std::make_pair(map, index));
1815 for (int i = 0; i < static_cast<int>(_edge_maps.size()); ++i) {
1816 std::map<std::string, int>::iterator jt =
1817 maps.find(_edge_maps[i].first);
1818 if (jt == maps.end()) {
1819 std::ostringstream msg;
1820 msg << "Map not found: " << _edge_maps[i].first;
1821 throw FormatError(msg.str());
1823 map_index[i] = jt->second;
1827 std::map<std::string, int>::iterator jt = maps.find("label");
1828 if (jt != maps.end()) {
1829 label_index = jt->second;
1834 map_num = maps.size();
1837 while (readLine() && line >> c && c != '@') {
1840 std::string source_token;
1841 std::string target_token;
1843 if (!_reader_bits::readToken(line, source_token))
1844 throw FormatError("Node u not found");
1846 if (!_reader_bits::readToken(line, target_token))
1847 throw FormatError("Node v not found");
1849 std::vector<std::string> tokens(map_num);
1850 for (int i = 0; i < map_num; ++i) {
1851 if (!_reader_bits::readToken(line, tokens[i])) {
1852 std::ostringstream msg;
1853 msg << "Column not found (" << i + 1 << ")";
1854 throw FormatError(msg.str());
1857 if (line >> std::ws >> c)
1858 throw FormatError("Extra character at the end of line");
1863 typename NodeIndex::iterator it;
1865 it = _node_index.find(source_token);
1866 if (it == _node_index.end()) {
1867 std::ostringstream msg;
1868 msg << "Item not found: " << source_token;
1869 throw FormatError(msg.str());
1871 Node source = it->second;
1873 it = _node_index.find(target_token);
1874 if (it == _node_index.end()) {
1875 std::ostringstream msg;
1876 msg << "Item not found: " << target_token;
1877 throw FormatError(msg.str());
1879 Node target = it->second;
1881 e = _graph.addEdge(source, target);
1882 if (label_index != -1)
1883 _edge_index.insert(std::make_pair(tokens[label_index], e));
1885 if (label_index == -1)
1886 throw FormatError("Label map not found");
1887 typename std::map<std::string, Edge>::iterator it =
1888 _edge_index.find(tokens[label_index]);
1889 if (it == _edge_index.end()) {
1890 std::ostringstream msg;
1891 msg << "Edge with label not found: " << tokens[label_index];
1892 throw FormatError(msg.str());
1897 for (int i = 0; i < static_cast<int>(_edge_maps.size()); ++i) {
1898 _edge_maps[i].second->set(e, tokens[map_index[i]]);
1902 if (readSuccess()) {
1907 void readAttributes() {
1909 std::set<std::string> read_attr;
1912 while (readLine() && line >> c && c != '@') {
1915 std::string attr, token;
1916 if (!_reader_bits::readToken(line, attr))
1917 throw FormatError("Attribute name not found");
1918 if (!_reader_bits::readToken(line, token))
1919 throw FormatError("Attribute value not found");
1921 throw FormatError("Extra character at the end of line");
1924 std::set<std::string>::iterator it = read_attr.find(attr);
1925 if (it != read_attr.end()) {
1926 std::ostringstream msg;
1927 msg << "Multiple occurence of attribute: " << attr;
1928 throw FormatError(msg.str());
1930 read_attr.insert(attr);
1934 typename Attributes::iterator it = _attributes.lower_bound(attr);
1935 while (it != _attributes.end() && it->first == attr) {
1936 it->second->set(token);
1942 if (readSuccess()) {
1945 for (typename Attributes::iterator it = _attributes.begin();
1946 it != _attributes.end(); ++it) {
1947 if (read_attr.find(it->first) == read_attr.end()) {
1948 std::ostringstream msg;
1949 msg << "Attribute not found: " << it->first;
1950 throw FormatError(msg.str());
1957 /// \name Execution of the reader
1960 /// \brief Start the batch processing
1962 /// This function starts the batch processing
1965 LEMON_ASSERT(_is != 0, "This reader assigned to an other reader");
1967 bool nodes_done = _skip_nodes;
1968 bool edges_done = _skip_edges;
1969 bool attributes_done = false;
1975 while (readSuccess()) {
1978 std::string section, caption;
1980 _reader_bits::readToken(line, section);
1981 _reader_bits::readToken(line, caption);
1984 throw FormatError("Extra character at the end of line");
1986 if (section == "nodes" && !nodes_done) {
1987 if (_nodes_caption.empty() || _nodes_caption == caption) {
1991 } else if ((section == "edges" || section == "arcs") &&
1993 if (_edges_caption.empty() || _edges_caption == caption) {
1997 } else if (section == "attributes" && !attributes_done) {
1998 if (_attributes_caption.empty() || _attributes_caption == caption) {
2000 attributes_done = true;
2006 } catch (FormatError& error) {
2007 error.line(line_num);
2008 error.file(_filename);
2014 throw FormatError("Section @nodes not found");
2018 throw FormatError("Section @edges not found");
2021 if (!attributes_done && !_attributes.empty()) {
2022 throw FormatError("Section @attributes not found");
2031 /// \brief Return a \ref GraphReader class
2033 /// This function just returns a \ref GraphReader class.
2034 /// \relates GraphReader
2035 template <typename Graph>
2036 GraphReader<Graph> graphReader(Graph& graph, std::istream& is) {
2037 GraphReader<Graph> tmp(graph, is);
2041 /// \brief Return a \ref GraphReader class
2043 /// This function just returns a \ref GraphReader class.
2044 /// \relates GraphReader
2045 template <typename Graph>
2046 GraphReader<Graph> graphReader(Graph& graph, const std::string& fn) {
2047 GraphReader<Graph> tmp(graph, fn);
2051 /// \brief Return a \ref GraphReader class
2053 /// This function just returns a \ref GraphReader class.
2054 /// \relates GraphReader
2055 template <typename Graph>
2056 GraphReader<Graph> graphReader(Graph& graph, const char* fn) {
2057 GraphReader<Graph> tmp(graph, fn);
2061 class SectionReader;
2063 SectionReader sectionReader(std::istream& is);
2064 SectionReader sectionReader(const std::string& fn);
2065 SectionReader sectionReader(const char* fn);
2067 /// \ingroup lemon_io
2069 /// \brief Section reader class
2071 /// In the \ref lgf-format "LGF" file extra sections can be placed,
2072 /// which contain any data in arbitrary format. Such sections can be
2073 /// read with this class. A reading rule can be added to the class
2074 /// with two different functions. With the \c sectionLines() function a
2075 /// functor can process the section line-by-line, while with the \c
2076 /// sectionStream() member the section can be read from an input
2078 class SectionReader {
2083 std::string _filename;
2085 typedef std::map<std::string, _reader_bits::Section*> Sections;
2089 std::istringstream line;
2093 /// \brief Constructor
2095 /// Construct a section reader, which reads from the given input
2097 SectionReader(std::istream& is)
2098 : _is(&is), local_is(false) {}
2100 /// \brief Constructor
2102 /// Construct a section reader, which reads from the given file.
2103 SectionReader(const std::string& fn)
2104 : _is(new std::ifstream(fn.c_str())), local_is(true),
2108 throw IoError("Cannot open file", fn);
2112 /// \brief Constructor
2114 /// Construct a section reader, which reads from the given file.
2115 SectionReader(const char* fn)
2116 : _is(new std::ifstream(fn)), local_is(true),
2120 throw IoError("Cannot open file", fn);
2124 /// \brief Destructor
2126 for (Sections::iterator it = _sections.begin();
2127 it != _sections.end(); ++it) {
2139 friend SectionReader sectionReader(std::istream& is);
2140 friend SectionReader sectionReader(const std::string& fn);
2141 friend SectionReader sectionReader(const char* fn);
2143 SectionReader(SectionReader& other)
2144 : _is(other._is), local_is(other.local_is) {
2147 other.local_is = false;
2149 _sections.swap(other._sections);
2152 SectionReader& operator=(const SectionReader&);
2156 /// \name Section readers
2159 /// \brief Add a section processor with line oriented reading
2161 /// The first parameter is the type descriptor of the section, the
2162 /// second is a functor, which takes just one \c std::string
2163 /// parameter. At the reading process, each line of the section
2164 /// will be given to the functor object. However, the empty lines
2165 /// and the comment lines are filtered out, and the leading
2166 /// whitespaces are trimmed from each processed string.
2168 /// For example let's see a section, which contain several
2169 /// integers, which should be inserted into a vector.
2177 /// The functor is implemented as a struct:
2179 /// struct NumberSection {
2180 /// std::vector<int>& _data;
2181 /// NumberSection(std::vector<int>& data) : _data(data) {}
2182 /// void operator()(const std::string& line) {
2183 /// std::istringstream ls(line);
2185 /// while (ls >> value) _data.push_back(value);
2191 /// reader.sectionLines("numbers", NumberSection(vec));
2193 template <typename Functor>
2194 SectionReader& sectionLines(const std::string& type, Functor functor) {
2195 LEMON_ASSERT(!type.empty(), "Type is empty.");
2196 LEMON_ASSERT(_sections.find(type) == _sections.end(),
2197 "Multiple reading of section.");
2198 _sections.insert(std::make_pair(type,
2199 new _reader_bits::LineSection<Functor>(functor)));
2204 /// \brief Add a section processor with stream oriented reading
2206 /// The first parameter is the type of the section, the second is
2207 /// a functor, which takes an \c std::istream& and an \c int&
2208 /// parameter, the latter regard to the line number of stream. The
2209 /// functor can read the input while the section go on, and the
2210 /// line number should be modified accordingly.
2211 template <typename Functor>
2212 SectionReader& sectionStream(const std::string& type, Functor functor) {
2213 LEMON_ASSERT(!type.empty(), "Type is empty.");
2214 LEMON_ASSERT(_sections.find(type) == _sections.end(),
2215 "Multiple reading of section.");
2216 _sections.insert(std::make_pair(type,
2217 new _reader_bits::StreamSection<Functor>(functor)));
2227 while(++line_num, std::getline(*_is, str)) {
2228 line.clear(); line.str(str);
2230 if (line >> std::ws >> c && c != '#') {
2238 bool readSuccess() {
2239 return static_cast<bool>(*_is);
2242 void skipSection() {
2244 while (readSuccess() && line >> c && c != '@') {
2253 /// \name Execution of the reader
2256 /// \brief Start the batch processing
2258 /// This function starts the batch processing.
2261 LEMON_ASSERT(_is != 0, "This reader assigned to an other reader");
2263 std::set<std::string> extra_sections;
2269 while (readSuccess()) {
2272 std::string section, caption;
2274 _reader_bits::readToken(line, section);
2275 _reader_bits::readToken(line, caption);
2278 throw FormatError("Extra character at the end of line");
2280 if (extra_sections.find(section) != extra_sections.end()) {
2281 std::ostringstream msg;
2282 msg << "Multiple occurence of section: " << section;
2283 throw FormatError(msg.str());
2285 Sections::iterator it = _sections.find(section);
2286 if (it != _sections.end()) {
2287 extra_sections.insert(section);
2288 it->second->process(*_is, line_num);
2292 } catch (FormatError& error) {
2293 error.line(line_num);
2294 error.file(_filename);
2298 for (Sections::iterator it = _sections.begin();
2299 it != _sections.end(); ++it) {
2300 if (extra_sections.find(it->first) == extra_sections.end()) {
2301 std::ostringstream os;
2302 os << "Cannot find section: " << it->first;
2303 throw FormatError(os.str());
2312 /// \brief Return a \ref SectionReader class
2314 /// This function just returns a \ref SectionReader class.
2315 /// \relates SectionReader
2316 inline SectionReader sectionReader(std::istream& is) {
2317 SectionReader tmp(is);
2321 /// \brief Return a \ref SectionReader class
2323 /// This function just returns a \ref SectionReader class.
2324 /// \relates SectionReader
2325 inline SectionReader sectionReader(const std::string& fn) {
2326 SectionReader tmp(fn);
2330 /// \brief Return a \ref SectionReader class
2332 /// This function just returns a \ref SectionReader class.
2333 /// \relates SectionReader
2334 inline SectionReader sectionReader(const char* fn) {
2335 SectionReader tmp(fn);
2339 /// \ingroup lemon_io
2341 /// \brief Reader for the contents of the \ref lgf-format "LGF" file
2343 /// This class can be used to read the sections, the map names and
2344 /// the attributes from a file. Usually, the LEMON programs know
2345 /// that, which type of graph, which maps and which attributes
2346 /// should be read from a file, but in general tools (like glemon)
2347 /// the contents of an LGF file should be guessed somehow. This class
2348 /// reads the graph and stores the appropriate information for
2349 /// reading the graph.
2352 /// LgfContents contents("graph.lgf");
2355 /// // Does it contain any node section and arc section?
2356 /// if (contents.nodeSectionNum() == 0 || contents.arcSectionNum()) {
2357 /// std::cerr << "Failure, cannot find graph." << std::endl;
2360 /// std::cout << "The name of the default node section: "
2361 /// << contents.nodeSection(0) << std::endl;
2362 /// std::cout << "The number of the arc maps: "
2363 /// << contents.arcMaps(0).size() << std::endl;
2364 /// std::cout << "The name of second arc map: "
2365 /// << contents.arcMaps(0)[1] << std::endl;
2373 std::vector<std::string> _node_sections;
2374 std::vector<std::string> _edge_sections;
2375 std::vector<std::string> _attribute_sections;
2376 std::vector<std::string> _extra_sections;
2378 std::vector<bool> _arc_sections;
2380 std::vector<std::vector<std::string> > _node_maps;
2381 std::vector<std::vector<std::string> > _edge_maps;
2383 std::vector<std::vector<std::string> > _attributes;
2387 std::istringstream line;
2391 /// \brief Constructor
2393 /// Construct an \e LGF contents reader, which reads from the given
2395 LgfContents(std::istream& is)
2396 : _is(&is), local_is(false) {}
2398 /// \brief Constructor
2400 /// Construct an \e LGF contents reader, which reads from the given
2402 LgfContents(const std::string& fn)
2403 : _is(new std::ifstream(fn.c_str())), local_is(true) {
2406 throw IoError("Cannot open file", fn);
2410 /// \brief Constructor
2412 /// Construct an \e LGF contents reader, which reads from the given
2414 LgfContents(const char* fn)
2415 : _is(new std::ifstream(fn)), local_is(true) {
2418 throw IoError("Cannot open file", fn);
2422 /// \brief Destructor
2424 if (local_is) delete _is;
2429 LgfContents(const LgfContents&);
2430 LgfContents& operator=(const LgfContents&);
2435 /// \name Node sections
2438 /// \brief Gives back the number of node sections in the file.
2440 /// Gives back the number of node sections in the file.
2441 int nodeSectionNum() const {
2442 return _node_sections.size();
2445 /// \brief Returns the node section name at the given position.
2447 /// Returns the node section name at the given position.
2448 const std::string& nodeSection(int i) const {
2449 return _node_sections[i];
2452 /// \brief Gives back the node maps for the given section.
2454 /// Gives back the node maps for the given section.
2455 const std::vector<std::string>& nodeMapNames(int i) const {
2456 return _node_maps[i];
2461 /// \name Arc/Edge sections
2464 /// \brief Gives back the number of arc/edge sections in the file.
2466 /// Gives back the number of arc/edge sections in the file.
2467 /// \note It is synonym of \c edgeSectionNum().
2468 int arcSectionNum() const {
2469 return _edge_sections.size();
2472 /// \brief Returns the arc/edge section name at the given position.
2474 /// Returns the arc/edge section name at the given position.
2475 /// \note It is synonym of \c edgeSection().
2476 const std::string& arcSection(int i) const {
2477 return _edge_sections[i];
2480 /// \brief Gives back the arc/edge maps for the given section.
2482 /// Gives back the arc/edge maps for the given section.
2483 /// \note It is synonym of \c edgeMapNames().
2484 const std::vector<std::string>& arcMapNames(int i) const {
2485 return _edge_maps[i];
2493 /// \brief Gives back the number of arc/edge sections in the file.
2495 /// Gives back the number of arc/edge sections in the file.
2496 /// \note It is synonym of \c arcSectionNum().
2497 int edgeSectionNum() const {
2498 return _edge_sections.size();
2501 /// \brief Returns the section name at the given position.
2503 /// Returns the section name at the given position.
2504 /// \note It is synonym of \c arcSection().
2505 const std::string& edgeSection(int i) const {
2506 return _edge_sections[i];
2509 /// \brief Gives back the edge maps for the given section.
2511 /// Gives back the edge maps for the given section.
2512 /// \note It is synonym of \c arcMapNames().
2513 const std::vector<std::string>& edgeMapNames(int i) const {
2514 return _edge_maps[i];
2519 /// \name Attribute sections
2522 /// \brief Gives back the number of attribute sections in the file.
2524 /// Gives back the number of attribute sections in the file.
2525 int attributeSectionNum() const {
2526 return _attribute_sections.size();
2529 /// \brief Returns the attribute section name at the given position.
2531 /// Returns the attribute section name at the given position.
2532 const std::string& attributeSectionNames(int i) const {
2533 return _attribute_sections[i];
2536 /// \brief Gives back the attributes for the given section.
2538 /// Gives back the attributes for the given section.
2539 const std::vector<std::string>& attributes(int i) const {
2540 return _attributes[i];
2545 /// \name Extra sections
2548 /// \brief Gives back the number of extra sections in the file.
2550 /// Gives back the number of extra sections in the file.
2551 int extraSectionNum() const {
2552 return _extra_sections.size();
2555 /// \brief Returns the extra section type at the given position.
2557 /// Returns the section type at the given position.
2558 const std::string& extraSection(int i) const {
2559 return _extra_sections[i];
2568 while(++line_num, std::getline(*_is, str)) {
2569 line.clear(); line.str(str);
2571 if (line >> std::ws >> c && c != '#') {
2579 bool readSuccess() {
2580 return static_cast<bool>(*_is);
2583 void skipSection() {
2585 while (readSuccess() && line >> c && c != '@') {
2591 void readMaps(std::vector<std::string>& maps) {
2593 if (!readLine() || !(line >> c) || c == '@') {
2594 if (readSuccess() && line) line.putback(c);
2599 while (_reader_bits::readToken(line, map)) {
2600 maps.push_back(map);
2604 void readAttributes(std::vector<std::string>& attrs) {
2607 while (readSuccess() && line >> c && c != '@') {
2610 _reader_bits::readToken(line, attr);
2611 attrs.push_back(attr);
2619 /// \name Execution of the contents reader
2622 /// \brief Starts the reading
2624 /// This function starts the reading.
2630 while (readSuccess()) {
2635 std::string section, caption;
2636 _reader_bits::readToken(line, section);
2637 _reader_bits::readToken(line, caption);
2639 if (section == "nodes") {
2640 _node_sections.push_back(caption);
2641 _node_maps.push_back(std::vector<std::string>());
2642 readMaps(_node_maps.back());
2643 readLine(); skipSection();
2644 } else if (section == "arcs" || section == "edges") {
2645 _edge_sections.push_back(caption);
2646 _arc_sections.push_back(section == "arcs");
2647 _edge_maps.push_back(std::vector<std::string>());
2648 readMaps(_edge_maps.back());
2649 readLine(); skipSection();
2650 } else if (section == "attributes") {
2651 _attribute_sections.push_back(caption);
2652 _attributes.push_back(std::vector<std::string>());
2653 readAttributes(_attributes.back());
2655 _extra_sections.push_back(section);
2656 readLine(); skipSection();