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 /// \brief Return a \ref DigraphReader class
395 /// This function just returns a \ref DigraphReader class.
396 /// \relates DigraphReader
397 template <typename Digraph>
398 DigraphReader<Digraph> digraphReader(Digraph& digraph,
399 std::istream& is = std::cin) {
400 DigraphReader<Digraph> tmp(digraph, is);
404 /// \brief Return a \ref DigraphReader class
406 /// This function just returns a \ref DigraphReader class.
407 /// \relates DigraphReader
408 template <typename Digraph>
409 DigraphReader<Digraph> digraphReader(Digraph& digraph,
410 const std::string& fn) {
411 DigraphReader<Digraph> tmp(digraph, fn);
415 /// \brief Return a \ref DigraphReader class
417 /// This function just returns a \ref DigraphReader class.
418 /// \relates DigraphReader
419 template <typename Digraph>
420 DigraphReader<Digraph> digraphReader(Digraph& digraph, const char* fn) {
421 DigraphReader<Digraph> tmp(digraph, fn);
425 /// \ingroup lemon_io
427 /// \brief \ref lgf-format "LGF" reader for directed graphs
429 /// This utility reads an \ref lgf-format "LGF" file.
431 /// The reading method does a batch processing. The user creates a
432 /// reader object, then various reading rules can be added to the
433 /// reader, and eventually the reading is executed with the \c run()
434 /// member function. A map reading rule can be added to the reader
435 /// with the \c nodeMap() or \c arcMap() members. An optional
436 /// converter parameter can also be added as a standard functor
437 /// converting from \c std::string to the value type of the map. If it
438 /// is set, it will determine how the tokens in the file should be
439 /// converted to the value type of the map. If the functor is not set,
440 /// then a default conversion will be used. One map can be read into
441 /// multiple map objects at the same time. The \c attribute(), \c
442 /// node() and \c arc() functions are used to add attribute reading
446 /// DigraphReader<Digraph>(digraph, std::cin).
447 /// nodeMap("coordinates", coord_map).
448 /// arcMap("capacity", cap_map).
449 /// node("source", src).
450 /// node("target", trg).
451 /// attribute("caption", caption).
455 /// By default the reader uses the first section in the file of the
456 /// proper type. If a section has an optional name, then it can be
457 /// selected for reading by giving an optional name parameter to the
458 /// \c nodes(), \c arcs() or \c attributes() functions.
460 /// The \c useNodes() and \c useArcs() functions are used to tell the reader
461 /// that the nodes or arcs should not be constructed (added to the
462 /// graph) during the reading, but instead the label map of the items
463 /// are given as a parameter of these functions. An
464 /// application of these functions is multipass reading, which is
465 /// important if two \c \@arcs sections must be read from the
466 /// file. In this case the first phase would read the node set and one
467 /// of the arc sets, while the second phase would read the second arc
468 /// set into an \e ArcSet class (\c SmartArcSet or \c ListArcSet).
469 /// The previously read label node map should be passed to the \c
470 /// useNodes() functions. Another application of multipass reading when
471 /// paths are given as a node map or an arc map.
472 /// It is impossible to read this in
473 /// a single pass, because the arcs are not constructed when the node
475 template <typename _Digraph>
476 class DigraphReader {
479 typedef _Digraph Digraph;
480 TEMPLATE_DIGRAPH_TYPEDEFS(Digraph);
487 std::string _filename;
491 std::string _nodes_caption;
492 std::string _arcs_caption;
493 std::string _attributes_caption;
495 typedef std::map<std::string, Node> NodeIndex;
496 NodeIndex _node_index;
497 typedef std::map<std::string, Arc> ArcIndex;
500 typedef std::vector<std::pair<std::string,
501 _reader_bits::MapStorageBase<Node>*> > NodeMaps;
504 typedef std::vector<std::pair<std::string,
505 _reader_bits::MapStorageBase<Arc>*> >ArcMaps;
508 typedef std::multimap<std::string, _reader_bits::ValueStorageBase*>
510 Attributes _attributes;
519 std::istringstream line;
523 /// \brief Constructor
525 /// Construct a directed graph reader, which reads from the given
527 DigraphReader(Digraph& digraph, std::istream& is = std::cin)
528 : _is(&is), local_is(false), _digraph(digraph),
529 _use_nodes(false), _use_arcs(false),
530 _skip_nodes(false), _skip_arcs(false) {}
532 /// \brief Constructor
534 /// Construct a directed graph reader, which reads from the given
536 DigraphReader(Digraph& digraph, const std::string& fn)
537 : _is(new std::ifstream(fn.c_str())), local_is(true),
538 _filename(fn), _digraph(digraph),
539 _use_nodes(false), _use_arcs(false),
540 _skip_nodes(false), _skip_arcs(false) {
543 throw IoError("Cannot open file", fn);
547 /// \brief Constructor
549 /// Construct a directed graph reader, which reads from the given
551 DigraphReader(Digraph& digraph, const char* fn)
552 : _is(new std::ifstream(fn)), local_is(true),
553 _filename(fn), _digraph(digraph),
554 _use_nodes(false), _use_arcs(false),
555 _skip_nodes(false), _skip_arcs(false) {
558 throw IoError("Cannot open file", fn);
562 /// \brief Destructor
564 for (typename NodeMaps::iterator it = _node_maps.begin();
565 it != _node_maps.end(); ++it) {
569 for (typename ArcMaps::iterator it = _arc_maps.begin();
570 it != _arc_maps.end(); ++it) {
574 for (typename Attributes::iterator it = _attributes.begin();
575 it != _attributes.end(); ++it) {
587 friend DigraphReader<Digraph> digraphReader<>(Digraph& digraph,
589 friend DigraphReader<Digraph> digraphReader<>(Digraph& digraph,
590 const std::string& fn);
591 friend DigraphReader<Digraph> digraphReader<>(Digraph& digraph,
594 DigraphReader(DigraphReader& other)
595 : _is(other._is), local_is(other.local_is), _digraph(other._digraph),
596 _use_nodes(other._use_nodes), _use_arcs(other._use_arcs),
597 _skip_nodes(other._skip_nodes), _skip_arcs(other._skip_arcs) {
600 other.local_is = false;
602 _node_index.swap(other._node_index);
603 _arc_index.swap(other._arc_index);
605 _node_maps.swap(other._node_maps);
606 _arc_maps.swap(other._arc_maps);
607 _attributes.swap(other._attributes);
609 _nodes_caption = other._nodes_caption;
610 _arcs_caption = other._arcs_caption;
611 _attributes_caption = other._attributes_caption;
615 DigraphReader& operator=(const DigraphReader&);
619 /// \name Reading rules
622 /// \brief Node map reading rule
624 /// Add a node map reading rule to the reader.
625 template <typename Map>
626 DigraphReader& nodeMap(const std::string& caption, Map& map) {
627 checkConcept<concepts::WriteMap<Node, typename Map::Value>, Map>();
628 _reader_bits::MapStorageBase<Node>* storage =
629 new _reader_bits::MapStorage<Node, Map>(map);
630 _node_maps.push_back(std::make_pair(caption, storage));
634 /// \brief Node map reading rule
636 /// Add a node map reading rule with specialized converter to the
638 template <typename Map, typename Converter>
639 DigraphReader& nodeMap(const std::string& caption, Map& map,
640 const Converter& converter = Converter()) {
641 checkConcept<concepts::WriteMap<Node, typename Map::Value>, Map>();
642 _reader_bits::MapStorageBase<Node>* storage =
643 new _reader_bits::MapStorage<Node, Map, Converter>(map, converter);
644 _node_maps.push_back(std::make_pair(caption, storage));
648 /// \brief Arc map reading rule
650 /// Add an arc map reading rule to the reader.
651 template <typename Map>
652 DigraphReader& arcMap(const std::string& caption, Map& map) {
653 checkConcept<concepts::WriteMap<Arc, typename Map::Value>, Map>();
654 _reader_bits::MapStorageBase<Arc>* storage =
655 new _reader_bits::MapStorage<Arc, Map>(map);
656 _arc_maps.push_back(std::make_pair(caption, storage));
660 /// \brief Arc map reading rule
662 /// Add an arc map reading rule with specialized converter to the
664 template <typename Map, typename Converter>
665 DigraphReader& arcMap(const std::string& caption, Map& map,
666 const Converter& converter = Converter()) {
667 checkConcept<concepts::WriteMap<Arc, typename Map::Value>, Map>();
668 _reader_bits::MapStorageBase<Arc>* storage =
669 new _reader_bits::MapStorage<Arc, Map, Converter>(map, converter);
670 _arc_maps.push_back(std::make_pair(caption, storage));
674 /// \brief Attribute reading rule
676 /// Add an attribute reading rule to the reader.
677 template <typename Value>
678 DigraphReader& attribute(const std::string& caption, Value& value) {
679 _reader_bits::ValueStorageBase* storage =
680 new _reader_bits::ValueStorage<Value>(value);
681 _attributes.insert(std::make_pair(caption, storage));
685 /// \brief Attribute reading rule
687 /// Add an attribute reading rule with specialized converter to the
689 template <typename Value, typename Converter>
690 DigraphReader& attribute(const std::string& caption, Value& value,
691 const Converter& converter = Converter()) {
692 _reader_bits::ValueStorageBase* storage =
693 new _reader_bits::ValueStorage<Value, Converter>(value, converter);
694 _attributes.insert(std::make_pair(caption, storage));
698 /// \brief Node reading rule
700 /// Add a node reading rule to reader.
701 DigraphReader& node(const std::string& caption, Node& node) {
702 typedef _reader_bits::MapLookUpConverter<Node> Converter;
703 Converter converter(_node_index);
704 _reader_bits::ValueStorageBase* storage =
705 new _reader_bits::ValueStorage<Node, Converter>(node, converter);
706 _attributes.insert(std::make_pair(caption, storage));
710 /// \brief Arc reading rule
712 /// Add an arc reading rule to reader.
713 DigraphReader& arc(const std::string& caption, Arc& arc) {
714 typedef _reader_bits::MapLookUpConverter<Arc> Converter;
715 Converter converter(_arc_index);
716 _reader_bits::ValueStorageBase* storage =
717 new _reader_bits::ValueStorage<Arc, Converter>(arc, converter);
718 _attributes.insert(std::make_pair(caption, storage));
724 /// \name Select section by name
727 /// \brief Set \c \@nodes section to be read
729 /// Set \c \@nodes section to be read
730 DigraphReader& nodes(const std::string& caption) {
731 _nodes_caption = caption;
735 /// \brief Set \c \@arcs section to be read
737 /// Set \c \@arcs section to be read
738 DigraphReader& arcs(const std::string& caption) {
739 _arcs_caption = caption;
743 /// \brief Set \c \@attributes section to be read
745 /// Set \c \@attributes section to be read
746 DigraphReader& attributes(const std::string& caption) {
747 _attributes_caption = caption;
753 /// \name Using previously constructed node or arc set
756 /// \brief Use previously constructed node set
758 /// Use previously constructed node set, and specify the node
760 template <typename Map>
761 DigraphReader& useNodes(const Map& map) {
762 checkConcept<concepts::ReadMap<Node, typename Map::Value>, Map>();
763 LEMON_ASSERT(!_use_nodes, "Multiple usage of useNodes() member");
765 _writer_bits::DefaultConverter<typename Map::Value> converter;
766 for (NodeIt n(_digraph); n != INVALID; ++n) {
767 _node_index.insert(std::make_pair(converter(map[n]), n));
772 /// \brief Use previously constructed node set
774 /// Use previously constructed node set, and specify the node
775 /// label map and a functor which converts the label map values to
777 template <typename Map, typename Converter>
778 DigraphReader& useNodes(const Map& map,
779 const Converter& converter = Converter()) {
780 checkConcept<concepts::ReadMap<Node, typename Map::Value>, Map>();
781 LEMON_ASSERT(!_use_nodes, "Multiple usage of useNodes() member");
783 for (NodeIt n(_digraph); n != INVALID; ++n) {
784 _node_index.insert(std::make_pair(converter(map[n]), n));
789 /// \brief Use previously constructed arc set
791 /// Use previously constructed arc set, and specify the arc
793 template <typename Map>
794 DigraphReader& useArcs(const Map& map) {
795 checkConcept<concepts::ReadMap<Arc, typename Map::Value>, Map>();
796 LEMON_ASSERT(!_use_arcs, "Multiple usage of useArcs() member");
798 _writer_bits::DefaultConverter<typename Map::Value> converter;
799 for (ArcIt a(_digraph); a != INVALID; ++a) {
800 _arc_index.insert(std::make_pair(converter(map[a]), a));
805 /// \brief Use previously constructed arc set
807 /// Use previously constructed arc set, and specify the arc
808 /// label map and a functor which converts the label map values to
810 template <typename Map, typename Converter>
811 DigraphReader& useArcs(const Map& map,
812 const Converter& converter = Converter()) {
813 checkConcept<concepts::ReadMap<Arc, typename Map::Value>, Map>();
814 LEMON_ASSERT(!_use_arcs, "Multiple usage of useArcs() member");
816 for (ArcIt a(_digraph); a != INVALID; ++a) {
817 _arc_index.insert(std::make_pair(converter(map[a]), a));
822 /// \brief Skips the reading of node section
824 /// Omit the reading of the node section. This implies that each node
825 /// map reading rule will be abandoned, and the nodes of the graph
826 /// will not be constructed, which usually cause that the arc set
827 /// could not be read due to lack of node name resolving.
828 /// Therefore \c skipArcs() function should also be used, or
829 /// \c useNodes() should be used to specify the label of the nodes.
830 DigraphReader& skipNodes() {
831 LEMON_ASSERT(!_skip_nodes, "Skip nodes already set");
836 /// \brief Skips the reading of arc section
838 /// Omit the reading of the arc section. This implies that each arc
839 /// map reading rule will be abandoned, and the arcs of the graph
840 /// will not be constructed.
841 DigraphReader& skipArcs() {
842 LEMON_ASSERT(!_skip_arcs, "Skip arcs already set");
853 while(++line_num, std::getline(*_is, str)) {
854 line.clear(); line.str(str);
856 if (line >> std::ws >> c && c != '#') {
865 return static_cast<bool>(*_is);
870 while (readSuccess() && line >> c && c != '@') {
878 std::vector<int> map_index(_node_maps.size());
879 int map_num, label_index;
882 if (!readLine() || !(line >> c) || c == '@') {
883 if (readSuccess() && line) line.putback(c);
884 if (!_node_maps.empty())
885 throw FormatError("Cannot find map names");
891 std::map<std::string, int> maps;
895 while (_reader_bits::readToken(line, map)) {
896 if (maps.find(map) != maps.end()) {
897 std::ostringstream msg;
898 msg << "Multiple occurence of node map: " << map;
899 throw FormatError(msg.str());
901 maps.insert(std::make_pair(map, index));
905 for (int i = 0; i < static_cast<int>(_node_maps.size()); ++i) {
906 std::map<std::string, int>::iterator jt =
907 maps.find(_node_maps[i].first);
908 if (jt == maps.end()) {
909 std::ostringstream msg;
910 msg << "Map not found: " << _node_maps[i].first;
911 throw FormatError(msg.str());
913 map_index[i] = jt->second;
917 std::map<std::string, int>::iterator jt = maps.find("label");
918 if (jt != maps.end()) {
919 label_index = jt->second;
924 map_num = maps.size();
927 while (readLine() && line >> c && c != '@') {
930 std::vector<std::string> tokens(map_num);
931 for (int i = 0; i < map_num; ++i) {
932 if (!_reader_bits::readToken(line, tokens[i])) {
933 std::ostringstream msg;
934 msg << "Column not found (" << i + 1 << ")";
935 throw FormatError(msg.str());
938 if (line >> std::ws >> c)
939 throw FormatError("Extra character at the end of line");
943 n = _digraph.addNode();
944 if (label_index != -1)
945 _node_index.insert(std::make_pair(tokens[label_index], n));
947 if (label_index == -1)
948 throw FormatError("Label map not found");
949 typename std::map<std::string, Node>::iterator it =
950 _node_index.find(tokens[label_index]);
951 if (it == _node_index.end()) {
952 std::ostringstream msg;
953 msg << "Node with label not found: " << tokens[label_index];
954 throw FormatError(msg.str());
959 for (int i = 0; i < static_cast<int>(_node_maps.size()); ++i) {
960 _node_maps[i].second->set(n, tokens[map_index[i]]);
971 std::vector<int> map_index(_arc_maps.size());
972 int map_num, label_index;
975 if (!readLine() || !(line >> c) || c == '@') {
976 if (readSuccess() && line) line.putback(c);
977 if (!_arc_maps.empty())
978 throw FormatError("Cannot find map names");
984 std::map<std::string, int> maps;
988 while (_reader_bits::readToken(line, map)) {
989 if (maps.find(map) != maps.end()) {
990 std::ostringstream msg;
991 msg << "Multiple occurence of arc map: " << map;
992 throw FormatError(msg.str());
994 maps.insert(std::make_pair(map, index));
998 for (int i = 0; i < static_cast<int>(_arc_maps.size()); ++i) {
999 std::map<std::string, int>::iterator jt =
1000 maps.find(_arc_maps[i].first);
1001 if (jt == maps.end()) {
1002 std::ostringstream msg;
1003 msg << "Map not found: " << _arc_maps[i].first;
1004 throw FormatError(msg.str());
1006 map_index[i] = jt->second;
1010 std::map<std::string, int>::iterator jt = maps.find("label");
1011 if (jt != maps.end()) {
1012 label_index = jt->second;
1017 map_num = maps.size();
1020 while (readLine() && line >> c && c != '@') {
1023 std::string source_token;
1024 std::string target_token;
1026 if (!_reader_bits::readToken(line, source_token))
1027 throw FormatError("Source not found");
1029 if (!_reader_bits::readToken(line, target_token))
1030 throw FormatError("Target not found");
1032 std::vector<std::string> tokens(map_num);
1033 for (int i = 0; i < map_num; ++i) {
1034 if (!_reader_bits::readToken(line, tokens[i])) {
1035 std::ostringstream msg;
1036 msg << "Column not found (" << i + 1 << ")";
1037 throw FormatError(msg.str());
1040 if (line >> std::ws >> c)
1041 throw FormatError("Extra character at the end of line");
1046 typename NodeIndex::iterator it;
1048 it = _node_index.find(source_token);
1049 if (it == _node_index.end()) {
1050 std::ostringstream msg;
1051 msg << "Item not found: " << source_token;
1052 throw FormatError(msg.str());
1054 Node source = it->second;
1056 it = _node_index.find(target_token);
1057 if (it == _node_index.end()) {
1058 std::ostringstream msg;
1059 msg << "Item not found: " << target_token;
1060 throw FormatError(msg.str());
1062 Node target = it->second;
1064 a = _digraph.addArc(source, target);
1065 if (label_index != -1)
1066 _arc_index.insert(std::make_pair(tokens[label_index], a));
1068 if (label_index == -1)
1069 throw FormatError("Label map not found");
1070 typename std::map<std::string, Arc>::iterator it =
1071 _arc_index.find(tokens[label_index]);
1072 if (it == _arc_index.end()) {
1073 std::ostringstream msg;
1074 msg << "Arc with label not found: " << tokens[label_index];
1075 throw FormatError(msg.str());
1080 for (int i = 0; i < static_cast<int>(_arc_maps.size()); ++i) {
1081 _arc_maps[i].second->set(a, tokens[map_index[i]]);
1085 if (readSuccess()) {
1090 void readAttributes() {
1092 std::set<std::string> read_attr;
1095 while (readLine() && line >> c && c != '@') {
1098 std::string attr, token;
1099 if (!_reader_bits::readToken(line, attr))
1100 throw FormatError("Attribute name not found");
1101 if (!_reader_bits::readToken(line, token))
1102 throw FormatError("Attribute value not found");
1104 throw FormatError("Extra character at the end of line");
1107 std::set<std::string>::iterator it = read_attr.find(attr);
1108 if (it != read_attr.end()) {
1109 std::ostringstream msg;
1110 msg << "Multiple occurence of attribute: " << attr;
1111 throw FormatError(msg.str());
1113 read_attr.insert(attr);
1117 typename Attributes::iterator it = _attributes.lower_bound(attr);
1118 while (it != _attributes.end() && it->first == attr) {
1119 it->second->set(token);
1125 if (readSuccess()) {
1128 for (typename Attributes::iterator it = _attributes.begin();
1129 it != _attributes.end(); ++it) {
1130 if (read_attr.find(it->first) == read_attr.end()) {
1131 std::ostringstream msg;
1132 msg << "Attribute not found: " << it->first;
1133 throw FormatError(msg.str());
1140 /// \name Execution of the reader
1143 /// \brief Start the batch processing
1145 /// This function starts the batch processing
1147 LEMON_ASSERT(_is != 0, "This reader assigned to an other reader");
1149 bool nodes_done = _skip_nodes;
1150 bool arcs_done = _skip_arcs;
1151 bool attributes_done = false;
1157 while (readSuccess()) {
1160 std::string section, caption;
1162 _reader_bits::readToken(line, section);
1163 _reader_bits::readToken(line, caption);
1166 throw FormatError("Extra character at the end of line");
1168 if (section == "nodes" && !nodes_done) {
1169 if (_nodes_caption.empty() || _nodes_caption == caption) {
1173 } else if ((section == "arcs" || section == "edges") &&
1175 if (_arcs_caption.empty() || _arcs_caption == caption) {
1179 } else if (section == "attributes" && !attributes_done) {
1180 if (_attributes_caption.empty() || _attributes_caption == caption) {
1182 attributes_done = true;
1188 } catch (FormatError& error) {
1189 error.line(line_num);
1190 error.file(_filename);
1196 throw FormatError("Section @nodes not found");
1200 throw FormatError("Section @arcs not found");
1203 if (!attributes_done && !_attributes.empty()) {
1204 throw FormatError("Section @attributes not found");
1213 template <typename Graph>
1216 /// \brief Return a \ref GraphReader class
1218 /// This function just returns a \ref GraphReader class.
1219 /// \relates GraphReader
1220 template <typename Graph>
1221 GraphReader<Graph> graphReader(Graph& graph, std::istream& is = std::cin) {
1222 GraphReader<Graph> tmp(graph, is);
1226 /// \brief Return a \ref GraphReader class
1228 /// This function just returns a \ref GraphReader class.
1229 /// \relates GraphReader
1230 template <typename Graph>
1231 GraphReader<Graph> graphReader(Graph& graph, const std::string& fn) {
1232 GraphReader<Graph> tmp(graph, fn);
1236 /// \brief Return a \ref GraphReader class
1238 /// This function just returns a \ref GraphReader class.
1239 /// \relates GraphReader
1240 template <typename Graph>
1241 GraphReader<Graph> graphReader(Graph& graph, const char* fn) {
1242 GraphReader<Graph> tmp(graph, fn);
1246 /// \ingroup lemon_io
1248 /// \brief \ref lgf-format "LGF" reader for undirected graphs
1250 /// This utility reads an \ref lgf-format "LGF" file.
1252 /// It can be used almost the same way as \c DigraphReader.
1253 /// The only difference is that this class can handle edges and
1254 /// edge maps as well as arcs and arc maps.
1256 /// The columns in the \c \@edges (or \c \@arcs) section are the
1257 /// edge maps. However, if there are two maps with the same name
1258 /// prefixed with \c '+' and \c '-', then these can be read into an
1259 /// arc map. Similarly, an attribute can be read into an arc, if
1260 /// it's value is an edge label prefixed with \c '+' or \c '-'.
1261 template <typename _Graph>
1265 typedef _Graph Graph;
1266 TEMPLATE_GRAPH_TYPEDEFS(Graph);
1272 std::string _filename;
1276 std::string _nodes_caption;
1277 std::string _edges_caption;
1278 std::string _attributes_caption;
1280 typedef std::map<std::string, Node> NodeIndex;
1281 NodeIndex _node_index;
1282 typedef std::map<std::string, Edge> EdgeIndex;
1283 EdgeIndex _edge_index;
1285 typedef std::vector<std::pair<std::string,
1286 _reader_bits::MapStorageBase<Node>*> > NodeMaps;
1287 NodeMaps _node_maps;
1289 typedef std::vector<std::pair<std::string,
1290 _reader_bits::MapStorageBase<Edge>*> > EdgeMaps;
1291 EdgeMaps _edge_maps;
1293 typedef std::multimap<std::string, _reader_bits::ValueStorageBase*>
1295 Attributes _attributes;
1304 std::istringstream line;
1308 /// \brief Constructor
1310 /// Construct an undirected graph reader, which reads from the given
1312 GraphReader(Graph& graph, std::istream& is = std::cin)
1313 : _is(&is), local_is(false), _graph(graph),
1314 _use_nodes(false), _use_edges(false),
1315 _skip_nodes(false), _skip_edges(false) {}
1317 /// \brief Constructor
1319 /// Construct an undirected graph reader, which reads from the given
1321 GraphReader(Graph& graph, const std::string& fn)
1322 : _is(new std::ifstream(fn.c_str())), local_is(true),
1323 _filename(fn), _graph(graph),
1324 _use_nodes(false), _use_edges(false),
1325 _skip_nodes(false), _skip_edges(false) {
1328 throw IoError("Cannot open file", fn);
1332 /// \brief Constructor
1334 /// Construct an undirected graph reader, which reads from the given
1336 GraphReader(Graph& graph, const char* fn)
1337 : _is(new std::ifstream(fn)), local_is(true),
1338 _filename(fn), _graph(graph),
1339 _use_nodes(false), _use_edges(false),
1340 _skip_nodes(false), _skip_edges(false) {
1343 throw IoError("Cannot open file", fn);
1347 /// \brief Destructor
1349 for (typename NodeMaps::iterator it = _node_maps.begin();
1350 it != _node_maps.end(); ++it) {
1354 for (typename EdgeMaps::iterator it = _edge_maps.begin();
1355 it != _edge_maps.end(); ++it) {
1359 for (typename Attributes::iterator it = _attributes.begin();
1360 it != _attributes.end(); ++it) {
1371 friend GraphReader<Graph> graphReader<>(Graph& graph, std::istream& is);
1372 friend GraphReader<Graph> graphReader<>(Graph& graph,
1373 const std::string& fn);
1374 friend GraphReader<Graph> graphReader<>(Graph& graph, const char *fn);
1376 GraphReader(GraphReader& other)
1377 : _is(other._is), local_is(other.local_is), _graph(other._graph),
1378 _use_nodes(other._use_nodes), _use_edges(other._use_edges),
1379 _skip_nodes(other._skip_nodes), _skip_edges(other._skip_edges) {
1382 other.local_is = false;
1384 _node_index.swap(other._node_index);
1385 _edge_index.swap(other._edge_index);
1387 _node_maps.swap(other._node_maps);
1388 _edge_maps.swap(other._edge_maps);
1389 _attributes.swap(other._attributes);
1391 _nodes_caption = other._nodes_caption;
1392 _edges_caption = other._edges_caption;
1393 _attributes_caption = other._attributes_caption;
1397 GraphReader& operator=(const GraphReader&);
1401 /// \name Reading rules
1404 /// \brief Node map reading rule
1406 /// Add a node map reading rule to the reader.
1407 template <typename Map>
1408 GraphReader& nodeMap(const std::string& caption, Map& map) {
1409 checkConcept<concepts::WriteMap<Node, typename Map::Value>, Map>();
1410 _reader_bits::MapStorageBase<Node>* storage =
1411 new _reader_bits::MapStorage<Node, Map>(map);
1412 _node_maps.push_back(std::make_pair(caption, storage));
1416 /// \brief Node map reading rule
1418 /// Add a node map reading rule with specialized converter to the
1420 template <typename Map, typename Converter>
1421 GraphReader& nodeMap(const std::string& caption, Map& map,
1422 const Converter& converter = Converter()) {
1423 checkConcept<concepts::WriteMap<Node, typename Map::Value>, Map>();
1424 _reader_bits::MapStorageBase<Node>* storage =
1425 new _reader_bits::MapStorage<Node, Map, Converter>(map, converter);
1426 _node_maps.push_back(std::make_pair(caption, storage));
1430 /// \brief Edge map reading rule
1432 /// Add an edge map reading rule to the reader.
1433 template <typename Map>
1434 GraphReader& edgeMap(const std::string& caption, Map& map) {
1435 checkConcept<concepts::WriteMap<Edge, typename Map::Value>, Map>();
1436 _reader_bits::MapStorageBase<Edge>* storage =
1437 new _reader_bits::MapStorage<Edge, Map>(map);
1438 _edge_maps.push_back(std::make_pair(caption, storage));
1442 /// \brief Edge map reading rule
1444 /// Add an edge map reading rule with specialized converter to the
1446 template <typename Map, typename Converter>
1447 GraphReader& edgeMap(const std::string& caption, Map& map,
1448 const Converter& converter = Converter()) {
1449 checkConcept<concepts::WriteMap<Edge, typename Map::Value>, Map>();
1450 _reader_bits::MapStorageBase<Edge>* storage =
1451 new _reader_bits::MapStorage<Edge, Map, Converter>(map, converter);
1452 _edge_maps.push_back(std::make_pair(caption, storage));
1456 /// \brief Arc map reading rule
1458 /// Add an arc map reading rule to the reader.
1459 template <typename Map>
1460 GraphReader& arcMap(const std::string& caption, Map& map) {
1461 checkConcept<concepts::WriteMap<Arc, typename Map::Value>, Map>();
1462 _reader_bits::MapStorageBase<Edge>* forward_storage =
1463 new _reader_bits::GraphArcMapStorage<Graph, true, Map>(_graph, map);
1464 _edge_maps.push_back(std::make_pair('+' + caption, forward_storage));
1465 _reader_bits::MapStorageBase<Edge>* backward_storage =
1466 new _reader_bits::GraphArcMapStorage<Graph, false, Map>(_graph, map);
1467 _edge_maps.push_back(std::make_pair('-' + caption, backward_storage));
1471 /// \brief Arc map reading rule
1473 /// Add an arc map reading rule with specialized converter to the
1475 template <typename Map, typename Converter>
1476 GraphReader& arcMap(const std::string& caption, Map& map,
1477 const Converter& converter = Converter()) {
1478 checkConcept<concepts::WriteMap<Arc, typename Map::Value>, Map>();
1479 _reader_bits::MapStorageBase<Edge>* forward_storage =
1480 new _reader_bits::GraphArcMapStorage<Graph, true, Map, Converter>
1481 (_graph, map, converter);
1482 _edge_maps.push_back(std::make_pair('+' + caption, forward_storage));
1483 _reader_bits::MapStorageBase<Edge>* backward_storage =
1484 new _reader_bits::GraphArcMapStorage<Graph, false, Map, Converter>
1485 (_graph, map, converter);
1486 _edge_maps.push_back(std::make_pair('-' + caption, backward_storage));
1490 /// \brief Attribute reading rule
1492 /// Add an attribute reading rule to the reader.
1493 template <typename Value>
1494 GraphReader& attribute(const std::string& caption, Value& value) {
1495 _reader_bits::ValueStorageBase* storage =
1496 new _reader_bits::ValueStorage<Value>(value);
1497 _attributes.insert(std::make_pair(caption, storage));
1501 /// \brief Attribute reading rule
1503 /// Add an attribute reading rule with specialized converter to the
1505 template <typename Value, typename Converter>
1506 GraphReader& attribute(const std::string& caption, Value& value,
1507 const Converter& converter = Converter()) {
1508 _reader_bits::ValueStorageBase* storage =
1509 new _reader_bits::ValueStorage<Value, Converter>(value, converter);
1510 _attributes.insert(std::make_pair(caption, storage));
1514 /// \brief Node reading rule
1516 /// Add a node reading rule to reader.
1517 GraphReader& node(const std::string& caption, Node& node) {
1518 typedef _reader_bits::MapLookUpConverter<Node> Converter;
1519 Converter converter(_node_index);
1520 _reader_bits::ValueStorageBase* storage =
1521 new _reader_bits::ValueStorage<Node, Converter>(node, converter);
1522 _attributes.insert(std::make_pair(caption, storage));
1526 /// \brief Edge reading rule
1528 /// Add an edge reading rule to reader.
1529 GraphReader& edge(const std::string& caption, Edge& edge) {
1530 typedef _reader_bits::MapLookUpConverter<Edge> Converter;
1531 Converter converter(_edge_index);
1532 _reader_bits::ValueStorageBase* storage =
1533 new _reader_bits::ValueStorage<Edge, Converter>(edge, converter);
1534 _attributes.insert(std::make_pair(caption, storage));
1538 /// \brief Arc reading rule
1540 /// Add an arc reading rule to reader.
1541 GraphReader& arc(const std::string& caption, Arc& arc) {
1542 typedef _reader_bits::GraphArcLookUpConverter<Graph> Converter;
1543 Converter converter(_graph, _edge_index);
1544 _reader_bits::ValueStorageBase* storage =
1545 new _reader_bits::ValueStorage<Arc, Converter>(arc, converter);
1546 _attributes.insert(std::make_pair(caption, storage));
1552 /// \name Select section by name
1555 /// \brief Set \c \@nodes section to be read
1557 /// Set \c \@nodes section to be read.
1558 GraphReader& nodes(const std::string& caption) {
1559 _nodes_caption = caption;
1563 /// \brief Set \c \@edges section to be read
1565 /// Set \c \@edges section to be read.
1566 GraphReader& edges(const std::string& caption) {
1567 _edges_caption = caption;
1571 /// \brief Set \c \@attributes section to be read
1573 /// Set \c \@attributes section to be read.
1574 GraphReader& attributes(const std::string& caption) {
1575 _attributes_caption = caption;
1581 /// \name Using previously constructed node or edge set
1584 /// \brief Use previously constructed node set
1586 /// Use previously constructed node set, and specify the node
1588 template <typename Map>
1589 GraphReader& useNodes(const Map& map) {
1590 checkConcept<concepts::ReadMap<Node, typename Map::Value>, Map>();
1591 LEMON_ASSERT(!_use_nodes, "Multiple usage of useNodes() member");
1593 _writer_bits::DefaultConverter<typename Map::Value> converter;
1594 for (NodeIt n(_graph); n != INVALID; ++n) {
1595 _node_index.insert(std::make_pair(converter(map[n]), n));
1600 /// \brief Use previously constructed node set
1602 /// Use previously constructed node set, and specify the node
1603 /// label map and a functor which converts the label map values to
1605 template <typename Map, typename Converter>
1606 GraphReader& useNodes(const Map& map,
1607 const Converter& converter = Converter()) {
1608 checkConcept<concepts::ReadMap<Node, typename Map::Value>, Map>();
1609 LEMON_ASSERT(!_use_nodes, "Multiple usage of useNodes() member");
1611 for (NodeIt n(_graph); n != INVALID; ++n) {
1612 _node_index.insert(std::make_pair(converter(map[n]), n));
1617 /// \brief Use previously constructed edge set
1619 /// Use previously constructed edge set, and specify the edge
1621 template <typename Map>
1622 GraphReader& useEdges(const Map& map) {
1623 checkConcept<concepts::ReadMap<Edge, typename Map::Value>, Map>();
1624 LEMON_ASSERT(!_use_edges, "Multiple usage of useEdges() member");
1626 _writer_bits::DefaultConverter<typename Map::Value> converter;
1627 for (EdgeIt a(_graph); a != INVALID; ++a) {
1628 _edge_index.insert(std::make_pair(converter(map[a]), a));
1633 /// \brief Use previously constructed edge set
1635 /// Use previously constructed edge set, and specify the edge
1636 /// label map and a functor which converts the label map values to
1638 template <typename Map, typename Converter>
1639 GraphReader& useEdges(const Map& map,
1640 const Converter& converter = Converter()) {
1641 checkConcept<concepts::ReadMap<Edge, typename Map::Value>, Map>();
1642 LEMON_ASSERT(!_use_edges, "Multiple usage of useEdges() member");
1644 for (EdgeIt a(_graph); a != INVALID; ++a) {
1645 _edge_index.insert(std::make_pair(converter(map[a]), a));
1650 /// \brief Skip the reading of node section
1652 /// Omit the reading of the node section. This implies that each node
1653 /// map reading rule will be abandoned, and the nodes of the graph
1654 /// will not be constructed, which usually cause that the edge set
1655 /// could not be read due to lack of node name
1656 /// could not be read due to lack of node name resolving.
1657 /// Therefore \c skipEdges() function should also be used, or
1658 /// \c useNodes() should be used to specify the label of the nodes.
1659 GraphReader& skipNodes() {
1660 LEMON_ASSERT(!_skip_nodes, "Skip nodes already set");
1665 /// \brief Skip the reading of edge section
1667 /// Omit the reading of the edge section. This implies that each edge
1668 /// map reading rule will be abandoned, and the edges of the graph
1669 /// will not be constructed.
1670 GraphReader& skipEdges() {
1671 LEMON_ASSERT(!_skip_edges, "Skip edges already set");
1682 while(++line_num, std::getline(*_is, str)) {
1683 line.clear(); line.str(str);
1685 if (line >> std::ws >> c && c != '#') {
1693 bool readSuccess() {
1694 return static_cast<bool>(*_is);
1697 void skipSection() {
1699 while (readSuccess() && line >> c && c != '@') {
1707 std::vector<int> map_index(_node_maps.size());
1708 int map_num, label_index;
1711 if (!readLine() || !(line >> c) || c == '@') {
1712 if (readSuccess() && line) line.putback(c);
1713 if (!_node_maps.empty())
1714 throw FormatError("Cannot find map names");
1720 std::map<std::string, int> maps;
1724 while (_reader_bits::readToken(line, map)) {
1725 if (maps.find(map) != maps.end()) {
1726 std::ostringstream msg;
1727 msg << "Multiple occurence of node map: " << map;
1728 throw FormatError(msg.str());
1730 maps.insert(std::make_pair(map, index));
1734 for (int i = 0; i < static_cast<int>(_node_maps.size()); ++i) {
1735 std::map<std::string, int>::iterator jt =
1736 maps.find(_node_maps[i].first);
1737 if (jt == maps.end()) {
1738 std::ostringstream msg;
1739 msg << "Map not found: " << _node_maps[i].first;
1740 throw FormatError(msg.str());
1742 map_index[i] = jt->second;
1746 std::map<std::string, int>::iterator jt = maps.find("label");
1747 if (jt != maps.end()) {
1748 label_index = jt->second;
1753 map_num = maps.size();
1756 while (readLine() && line >> c && c != '@') {
1759 std::vector<std::string> tokens(map_num);
1760 for (int i = 0; i < map_num; ++i) {
1761 if (!_reader_bits::readToken(line, tokens[i])) {
1762 std::ostringstream msg;
1763 msg << "Column not found (" << i + 1 << ")";
1764 throw FormatError(msg.str());
1767 if (line >> std::ws >> c)
1768 throw FormatError("Extra character at the end of line");
1772 n = _graph.addNode();
1773 if (label_index != -1)
1774 _node_index.insert(std::make_pair(tokens[label_index], n));
1776 if (label_index == -1)
1777 throw FormatError("Label map not found");
1778 typename std::map<std::string, Node>::iterator it =
1779 _node_index.find(tokens[label_index]);
1780 if (it == _node_index.end()) {
1781 std::ostringstream msg;
1782 msg << "Node with label not found: " << tokens[label_index];
1783 throw FormatError(msg.str());
1788 for (int i = 0; i < static_cast<int>(_node_maps.size()); ++i) {
1789 _node_maps[i].second->set(n, tokens[map_index[i]]);
1793 if (readSuccess()) {
1800 std::vector<int> map_index(_edge_maps.size());
1801 int map_num, label_index;
1804 if (!readLine() || !(line >> c) || c == '@') {
1805 if (readSuccess() && line) line.putback(c);
1806 if (!_edge_maps.empty())
1807 throw FormatError("Cannot find map names");
1813 std::map<std::string, int> maps;
1817 while (_reader_bits::readToken(line, map)) {
1818 if (maps.find(map) != maps.end()) {
1819 std::ostringstream msg;
1820 msg << "Multiple occurence of edge map: " << map;
1821 throw FormatError(msg.str());
1823 maps.insert(std::make_pair(map, index));
1827 for (int i = 0; i < static_cast<int>(_edge_maps.size()); ++i) {
1828 std::map<std::string, int>::iterator jt =
1829 maps.find(_edge_maps[i].first);
1830 if (jt == maps.end()) {
1831 std::ostringstream msg;
1832 msg << "Map not found: " << _edge_maps[i].first;
1833 throw FormatError(msg.str());
1835 map_index[i] = jt->second;
1839 std::map<std::string, int>::iterator jt = maps.find("label");
1840 if (jt != maps.end()) {
1841 label_index = jt->second;
1846 map_num = maps.size();
1849 while (readLine() && line >> c && c != '@') {
1852 std::string source_token;
1853 std::string target_token;
1855 if (!_reader_bits::readToken(line, source_token))
1856 throw FormatError("Node u not found");
1858 if (!_reader_bits::readToken(line, target_token))
1859 throw FormatError("Node v not found");
1861 std::vector<std::string> tokens(map_num);
1862 for (int i = 0; i < map_num; ++i) {
1863 if (!_reader_bits::readToken(line, tokens[i])) {
1864 std::ostringstream msg;
1865 msg << "Column not found (" << i + 1 << ")";
1866 throw FormatError(msg.str());
1869 if (line >> std::ws >> c)
1870 throw FormatError("Extra character at the end of line");
1875 typename NodeIndex::iterator it;
1877 it = _node_index.find(source_token);
1878 if (it == _node_index.end()) {
1879 std::ostringstream msg;
1880 msg << "Item not found: " << source_token;
1881 throw FormatError(msg.str());
1883 Node source = it->second;
1885 it = _node_index.find(target_token);
1886 if (it == _node_index.end()) {
1887 std::ostringstream msg;
1888 msg << "Item not found: " << target_token;
1889 throw FormatError(msg.str());
1891 Node target = it->second;
1893 e = _graph.addEdge(source, target);
1894 if (label_index != -1)
1895 _edge_index.insert(std::make_pair(tokens[label_index], e));
1897 if (label_index == -1)
1898 throw FormatError("Label map not found");
1899 typename std::map<std::string, Edge>::iterator it =
1900 _edge_index.find(tokens[label_index]);
1901 if (it == _edge_index.end()) {
1902 std::ostringstream msg;
1903 msg << "Edge with label not found: " << tokens[label_index];
1904 throw FormatError(msg.str());
1909 for (int i = 0; i < static_cast<int>(_edge_maps.size()); ++i) {
1910 _edge_maps[i].second->set(e, tokens[map_index[i]]);
1914 if (readSuccess()) {
1919 void readAttributes() {
1921 std::set<std::string> read_attr;
1924 while (readLine() && line >> c && c != '@') {
1927 std::string attr, token;
1928 if (!_reader_bits::readToken(line, attr))
1929 throw FormatError("Attribute name not found");
1930 if (!_reader_bits::readToken(line, token))
1931 throw FormatError("Attribute value not found");
1933 throw FormatError("Extra character at the end of line");
1936 std::set<std::string>::iterator it = read_attr.find(attr);
1937 if (it != read_attr.end()) {
1938 std::ostringstream msg;
1939 msg << "Multiple occurence of attribute: " << attr;
1940 throw FormatError(msg.str());
1942 read_attr.insert(attr);
1946 typename Attributes::iterator it = _attributes.lower_bound(attr);
1947 while (it != _attributes.end() && it->first == attr) {
1948 it->second->set(token);
1954 if (readSuccess()) {
1957 for (typename Attributes::iterator it = _attributes.begin();
1958 it != _attributes.end(); ++it) {
1959 if (read_attr.find(it->first) == read_attr.end()) {
1960 std::ostringstream msg;
1961 msg << "Attribute not found: " << it->first;
1962 throw FormatError(msg.str());
1969 /// \name Execution of the reader
1972 /// \brief Start the batch processing
1974 /// This function starts the batch processing
1977 LEMON_ASSERT(_is != 0, "This reader assigned to an other reader");
1979 bool nodes_done = _skip_nodes;
1980 bool edges_done = _skip_edges;
1981 bool attributes_done = false;
1987 while (readSuccess()) {
1990 std::string section, caption;
1992 _reader_bits::readToken(line, section);
1993 _reader_bits::readToken(line, caption);
1996 throw FormatError("Extra character at the end of line");
1998 if (section == "nodes" && !nodes_done) {
1999 if (_nodes_caption.empty() || _nodes_caption == caption) {
2003 } else if ((section == "edges" || section == "arcs") &&
2005 if (_edges_caption.empty() || _edges_caption == caption) {
2009 } else if (section == "attributes" && !attributes_done) {
2010 if (_attributes_caption.empty() || _attributes_caption == caption) {
2012 attributes_done = true;
2018 } catch (FormatError& error) {
2019 error.line(line_num);
2020 error.file(_filename);
2026 throw FormatError("Section @nodes not found");
2030 throw FormatError("Section @edges not found");
2033 if (!attributes_done && !_attributes.empty()) {
2034 throw FormatError("Section @attributes not found");
2043 class SectionReader;
2045 SectionReader sectionReader(std::istream& is);
2046 SectionReader sectionReader(const std::string& fn);
2047 SectionReader sectionReader(const char* fn);
2049 /// \ingroup lemon_io
2051 /// \brief Section reader class
2053 /// In the \ref lgf-format "LGF" file extra sections can be placed,
2054 /// which contain any data in arbitrary format. Such sections can be
2055 /// read with this class. A reading rule can be added to the class
2056 /// with two different functions. With the \c sectionLines() function a
2057 /// functor can process the section line-by-line, while with the \c
2058 /// sectionStream() member the section can be read from an input
2060 class SectionReader {
2065 std::string _filename;
2067 typedef std::map<std::string, _reader_bits::Section*> Sections;
2071 std::istringstream line;
2075 /// \brief Constructor
2077 /// Construct a section reader, which reads from the given input
2079 SectionReader(std::istream& is)
2080 : _is(&is), local_is(false) {}
2082 /// \brief Constructor
2084 /// Construct a section reader, which reads from the given file.
2085 SectionReader(const std::string& fn)
2086 : _is(new std::ifstream(fn.c_str())), local_is(true),
2090 throw IoError("Cannot open file", fn);
2094 /// \brief Constructor
2096 /// Construct a section reader, which reads from the given file.
2097 SectionReader(const char* fn)
2098 : _is(new std::ifstream(fn)), local_is(true),
2102 throw IoError("Cannot open file", fn);
2106 /// \brief Destructor
2108 for (Sections::iterator it = _sections.begin();
2109 it != _sections.end(); ++it) {
2121 friend SectionReader sectionReader(std::istream& is);
2122 friend SectionReader sectionReader(const std::string& fn);
2123 friend SectionReader sectionReader(const char* fn);
2125 SectionReader(SectionReader& other)
2126 : _is(other._is), local_is(other.local_is) {
2129 other.local_is = false;
2131 _sections.swap(other._sections);
2134 SectionReader& operator=(const SectionReader&);
2138 /// \name Section readers
2141 /// \brief Add a section processor with line oriented reading
2143 /// The first parameter is the type descriptor of the section, the
2144 /// second is a functor, which takes just one \c std::string
2145 /// parameter. At the reading process, each line of the section
2146 /// will be given to the functor object. However, the empty lines
2147 /// and the comment lines are filtered out, and the leading
2148 /// whitespaces are trimmed from each processed string.
2150 /// For example let's see a section, which contain several
2151 /// integers, which should be inserted into a vector.
2159 /// The functor is implemented as a struct:
2161 /// struct NumberSection {
2162 /// std::vector<int>& _data;
2163 /// NumberSection(std::vector<int>& data) : _data(data) {}
2164 /// void operator()(const std::string& line) {
2165 /// std::istringstream ls(line);
2167 /// while (ls >> value) _data.push_back(value);
2173 /// reader.sectionLines("numbers", NumberSection(vec));
2175 template <typename Functor>
2176 SectionReader& sectionLines(const std::string& type, Functor functor) {
2177 LEMON_ASSERT(!type.empty(), "Type is empty.");
2178 LEMON_ASSERT(_sections.find(type) == _sections.end(),
2179 "Multiple reading of section.");
2180 _sections.insert(std::make_pair(type,
2181 new _reader_bits::LineSection<Functor>(functor)));
2186 /// \brief Add a section processor with stream oriented reading
2188 /// The first parameter is the type of the section, the second is
2189 /// a functor, which takes an \c std::istream& and an \c int&
2190 /// parameter, the latter regard to the line number of stream. The
2191 /// functor can read the input while the section go on, and the
2192 /// line number should be modified accordingly.
2193 template <typename Functor>
2194 SectionReader& sectionStream(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::StreamSection<Functor>(functor)));
2209 while(++line_num, std::getline(*_is, str)) {
2210 line.clear(); line.str(str);
2212 if (line >> std::ws >> c && c != '#') {
2220 bool readSuccess() {
2221 return static_cast<bool>(*_is);
2224 void skipSection() {
2226 while (readSuccess() && line >> c && c != '@') {
2235 /// \name Execution of the reader
2238 /// \brief Start the batch processing
2240 /// This function starts the batch processing.
2243 LEMON_ASSERT(_is != 0, "This reader assigned to an other reader");
2245 std::set<std::string> extra_sections;
2251 while (readSuccess()) {
2254 std::string section, caption;
2256 _reader_bits::readToken(line, section);
2257 _reader_bits::readToken(line, caption);
2260 throw FormatError("Extra character at the end of line");
2262 if (extra_sections.find(section) != extra_sections.end()) {
2263 std::ostringstream msg;
2264 msg << "Multiple occurence of section: " << section;
2265 throw FormatError(msg.str());
2267 Sections::iterator it = _sections.find(section);
2268 if (it != _sections.end()) {
2269 extra_sections.insert(section);
2270 it->second->process(*_is, line_num);
2274 } catch (FormatError& error) {
2275 error.line(line_num);
2276 error.file(_filename);
2280 for (Sections::iterator it = _sections.begin();
2281 it != _sections.end(); ++it) {
2282 if (extra_sections.find(it->first) == extra_sections.end()) {
2283 std::ostringstream os;
2284 os << "Cannot find section: " << it->first;
2285 throw FormatError(os.str());
2294 /// \brief Return a \ref SectionReader class
2296 /// This function just returns a \ref SectionReader class.
2297 /// \relates SectionReader
2298 inline SectionReader sectionReader(std::istream& is) {
2299 SectionReader tmp(is);
2303 /// \brief Return a \ref SectionReader class
2305 /// This function just returns a \ref SectionReader class.
2306 /// \relates SectionReader
2307 inline SectionReader sectionReader(const std::string& fn) {
2308 SectionReader tmp(fn);
2312 /// \brief Return a \ref SectionReader class
2314 /// This function just returns a \ref SectionReader class.
2315 /// \relates SectionReader
2316 inline SectionReader sectionReader(const char* fn) {
2317 SectionReader tmp(fn);
2321 /// \ingroup lemon_io
2323 /// \brief Reader for the contents of the \ref lgf-format "LGF" file
2325 /// This class can be used to read the sections, the map names and
2326 /// the attributes from a file. Usually, the LEMON programs know
2327 /// that, which type of graph, which maps and which attributes
2328 /// should be read from a file, but in general tools (like glemon)
2329 /// the contents of an LGF file should be guessed somehow. This class
2330 /// reads the graph and stores the appropriate information for
2331 /// reading the graph.
2334 /// LgfContents contents("graph.lgf");
2337 /// // Does it contain any node section and arc section?
2338 /// if (contents.nodeSectionNum() == 0 || contents.arcSectionNum()) {
2339 /// std::cerr << "Failure, cannot find graph." << std::endl;
2342 /// std::cout << "The name of the default node section: "
2343 /// << contents.nodeSection(0) << std::endl;
2344 /// std::cout << "The number of the arc maps: "
2345 /// << contents.arcMaps(0).size() << std::endl;
2346 /// std::cout << "The name of second arc map: "
2347 /// << contents.arcMaps(0)[1] << std::endl;
2355 std::vector<std::string> _node_sections;
2356 std::vector<std::string> _edge_sections;
2357 std::vector<std::string> _attribute_sections;
2358 std::vector<std::string> _extra_sections;
2360 std::vector<bool> _arc_sections;
2362 std::vector<std::vector<std::string> > _node_maps;
2363 std::vector<std::vector<std::string> > _edge_maps;
2365 std::vector<std::vector<std::string> > _attributes;
2369 std::istringstream line;
2373 /// \brief Constructor
2375 /// Construct an \e LGF contents reader, which reads from the given
2377 LgfContents(std::istream& is)
2378 : _is(&is), local_is(false) {}
2380 /// \brief Constructor
2382 /// Construct an \e LGF contents reader, which reads from the given
2384 LgfContents(const std::string& fn)
2385 : _is(new std::ifstream(fn.c_str())), local_is(true) {
2388 throw IoError("Cannot open file", fn);
2392 /// \brief Constructor
2394 /// Construct an \e LGF contents reader, which reads from the given
2396 LgfContents(const char* fn)
2397 : _is(new std::ifstream(fn)), local_is(true) {
2400 throw IoError("Cannot open file", fn);
2404 /// \brief Destructor
2406 if (local_is) delete _is;
2411 LgfContents(const LgfContents&);
2412 LgfContents& operator=(const LgfContents&);
2417 /// \name Node sections
2420 /// \brief Gives back the number of node sections in the file.
2422 /// Gives back the number of node sections in the file.
2423 int nodeSectionNum() const {
2424 return _node_sections.size();
2427 /// \brief Returns the node section name at the given position.
2429 /// Returns the node section name at the given position.
2430 const std::string& nodeSection(int i) const {
2431 return _node_sections[i];
2434 /// \brief Gives back the node maps for the given section.
2436 /// Gives back the node maps for the given section.
2437 const std::vector<std::string>& nodeMapNames(int i) const {
2438 return _node_maps[i];
2443 /// \name Arc/Edge sections
2446 /// \brief Gives back the number of arc/edge sections in the file.
2448 /// Gives back the number of arc/edge sections in the file.
2449 /// \note It is synonym of \c edgeSectionNum().
2450 int arcSectionNum() const {
2451 return _edge_sections.size();
2454 /// \brief Returns the arc/edge section name at the given position.
2456 /// Returns the arc/edge section name at the given position.
2457 /// \note It is synonym of \c edgeSection().
2458 const std::string& arcSection(int i) const {
2459 return _edge_sections[i];
2462 /// \brief Gives back the arc/edge maps for the given section.
2464 /// Gives back the arc/edge maps for the given section.
2465 /// \note It is synonym of \c edgeMapNames().
2466 const std::vector<std::string>& arcMapNames(int i) const {
2467 return _edge_maps[i];
2475 /// \brief Gives back the number of arc/edge sections in the file.
2477 /// Gives back the number of arc/edge sections in the file.
2478 /// \note It is synonym of \c arcSectionNum().
2479 int edgeSectionNum() const {
2480 return _edge_sections.size();
2483 /// \brief Returns the section name at the given position.
2485 /// Returns the section name at the given position.
2486 /// \note It is synonym of \c arcSection().
2487 const std::string& edgeSection(int i) const {
2488 return _edge_sections[i];
2491 /// \brief Gives back the edge maps for the given section.
2493 /// Gives back the edge maps for the given section.
2494 /// \note It is synonym of \c arcMapNames().
2495 const std::vector<std::string>& edgeMapNames(int i) const {
2496 return _edge_maps[i];
2501 /// \name Attribute sections
2504 /// \brief Gives back the number of attribute sections in the file.
2506 /// Gives back the number of attribute sections in the file.
2507 int attributeSectionNum() const {
2508 return _attribute_sections.size();
2511 /// \brief Returns the attribute section name at the given position.
2513 /// Returns the attribute section name at the given position.
2514 const std::string& attributeSectionNames(int i) const {
2515 return _attribute_sections[i];
2518 /// \brief Gives back the attributes for the given section.
2520 /// Gives back the attributes for the given section.
2521 const std::vector<std::string>& attributes(int i) const {
2522 return _attributes[i];
2527 /// \name Extra sections
2530 /// \brief Gives back the number of extra sections in the file.
2532 /// Gives back the number of extra sections in the file.
2533 int extraSectionNum() const {
2534 return _extra_sections.size();
2537 /// \brief Returns the extra section type at the given position.
2539 /// Returns the section type at the given position.
2540 const std::string& extraSection(int i) const {
2541 return _extra_sections[i];
2550 while(++line_num, std::getline(*_is, str)) {
2551 line.clear(); line.str(str);
2553 if (line >> std::ws >> c && c != '#') {
2561 bool readSuccess() {
2562 return static_cast<bool>(*_is);
2565 void skipSection() {
2567 while (readSuccess() && line >> c && c != '@') {
2573 void readMaps(std::vector<std::string>& maps) {
2575 if (!readLine() || !(line >> c) || c == '@') {
2576 if (readSuccess() && line) line.putback(c);
2581 while (_reader_bits::readToken(line, map)) {
2582 maps.push_back(map);
2586 void readAttributes(std::vector<std::string>& attrs) {
2589 while (readSuccess() && line >> c && c != '@') {
2592 _reader_bits::readToken(line, attr);
2593 attrs.push_back(attr);
2601 /// \name Execution of the contents reader
2604 /// \brief Starts the reading
2606 /// This function starts the reading.
2612 while (readSuccess()) {
2617 std::string section, caption;
2618 _reader_bits::readToken(line, section);
2619 _reader_bits::readToken(line, caption);
2621 if (section == "nodes") {
2622 _node_sections.push_back(caption);
2623 _node_maps.push_back(std::vector<std::string>());
2624 readMaps(_node_maps.back());
2625 readLine(); skipSection();
2626 } else if (section == "arcs" || section == "edges") {
2627 _edge_sections.push_back(caption);
2628 _arc_sections.push_back(section == "arcs");
2629 _edge_maps.push_back(std::vector<std::string>());
2630 readMaps(_edge_maps.back());
2631 readLine(); skipSection();
2632 } else if (section == "attributes") {
2633 _attribute_sections.push_back(caption);
2634 _attributes.push_back(std::vector<std::string>());
2635 readAttributes(_attributes.back());
2637 _extra_sections.push_back(section);
2638 readLine(); skipSection();