1 /* -*- mode: C++; indent-tabs-mode: nil; -*-
3 * This file is a part of LEMON, a generic C++ optimization library.
5 * Copyright (C) 2003-2009
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 != '@') {
880 std::vector<int> map_index(_node_maps.size());
881 int map_num, label_index;
884 if (!readLine() || !(line >> c) || c == '@') {
885 if (readSuccess() && line) line.putback(c);
886 if (!_node_maps.empty())
887 throw FormatError("Cannot find map names");
893 std::map<std::string, int> maps;
897 while (_reader_bits::readToken(line, map)) {
898 if (maps.find(map) != maps.end()) {
899 std::ostringstream msg;
900 msg << "Multiple occurence of node map: " << map;
901 throw FormatError(msg.str());
903 maps.insert(std::make_pair(map, index));
907 for (int i = 0; i < static_cast<int>(_node_maps.size()); ++i) {
908 std::map<std::string, int>::iterator jt =
909 maps.find(_node_maps[i].first);
910 if (jt == maps.end()) {
911 std::ostringstream msg;
912 msg << "Map not found: " << _node_maps[i].first;
913 throw FormatError(msg.str());
915 map_index[i] = jt->second;
919 std::map<std::string, int>::iterator jt = maps.find("label");
920 if (jt != maps.end()) {
921 label_index = jt->second;
926 map_num = maps.size();
929 while (readLine() && line >> c && c != '@') {
932 std::vector<std::string> tokens(map_num);
933 for (int i = 0; i < map_num; ++i) {
934 if (!_reader_bits::readToken(line, tokens[i])) {
935 std::ostringstream msg;
936 msg << "Column not found (" << i + 1 << ")";
937 throw FormatError(msg.str());
940 if (line >> std::ws >> c)
941 throw FormatError("Extra character at the end of line");
945 n = _digraph.addNode();
946 if (label_index != -1)
947 _node_index.insert(std::make_pair(tokens[label_index], n));
949 if (label_index == -1)
950 throw FormatError("Label map not found");
951 typename std::map<std::string, Node>::iterator it =
952 _node_index.find(tokens[label_index]);
953 if (it == _node_index.end()) {
954 std::ostringstream msg;
955 msg << "Node with label not found: " << tokens[label_index];
956 throw FormatError(msg.str());
961 for (int i = 0; i < static_cast<int>(_node_maps.size()); ++i) {
962 _node_maps[i].second->set(n, tokens[map_index[i]]);
973 std::vector<int> map_index(_arc_maps.size());
974 int map_num, label_index;
977 if (!readLine() || !(line >> c) || c == '@') {
978 if (readSuccess() && line) line.putback(c);
979 if (!_arc_maps.empty())
980 throw FormatError("Cannot find map names");
986 std::map<std::string, int> maps;
990 while (_reader_bits::readToken(line, map)) {
991 if (maps.find(map) != maps.end()) {
992 std::ostringstream msg;
993 msg << "Multiple occurence of arc map: " << map;
994 throw FormatError(msg.str());
996 maps.insert(std::make_pair(map, index));
1000 for (int i = 0; i < static_cast<int>(_arc_maps.size()); ++i) {
1001 std::map<std::string, int>::iterator jt =
1002 maps.find(_arc_maps[i].first);
1003 if (jt == maps.end()) {
1004 std::ostringstream msg;
1005 msg << "Map not found: " << _arc_maps[i].first;
1006 throw FormatError(msg.str());
1008 map_index[i] = jt->second;
1012 std::map<std::string, int>::iterator jt = maps.find("label");
1013 if (jt != maps.end()) {
1014 label_index = jt->second;
1019 map_num = maps.size();
1022 while (readLine() && line >> c && c != '@') {
1025 std::string source_token;
1026 std::string target_token;
1028 if (!_reader_bits::readToken(line, source_token))
1029 throw FormatError("Source not found");
1031 if (!_reader_bits::readToken(line, target_token))
1032 throw FormatError("Target not found");
1034 std::vector<std::string> tokens(map_num);
1035 for (int i = 0; i < map_num; ++i) {
1036 if (!_reader_bits::readToken(line, tokens[i])) {
1037 std::ostringstream msg;
1038 msg << "Column not found (" << i + 1 << ")";
1039 throw FormatError(msg.str());
1042 if (line >> std::ws >> c)
1043 throw FormatError("Extra character at the end of line");
1048 typename NodeIndex::iterator it;
1050 it = _node_index.find(source_token);
1051 if (it == _node_index.end()) {
1052 std::ostringstream msg;
1053 msg << "Item not found: " << source_token;
1054 throw FormatError(msg.str());
1056 Node source = it->second;
1058 it = _node_index.find(target_token);
1059 if (it == _node_index.end()) {
1060 std::ostringstream msg;
1061 msg << "Item not found: " << target_token;
1062 throw FormatError(msg.str());
1064 Node target = it->second;
1066 a = _digraph.addArc(source, target);
1067 if (label_index != -1)
1068 _arc_index.insert(std::make_pair(tokens[label_index], a));
1070 if (label_index == -1)
1071 throw FormatError("Label map not found");
1072 typename std::map<std::string, Arc>::iterator it =
1073 _arc_index.find(tokens[label_index]);
1074 if (it == _arc_index.end()) {
1075 std::ostringstream msg;
1076 msg << "Arc with label not found: " << tokens[label_index];
1077 throw FormatError(msg.str());
1082 for (int i = 0; i < static_cast<int>(_arc_maps.size()); ++i) {
1083 _arc_maps[i].second->set(a, tokens[map_index[i]]);
1087 if (readSuccess()) {
1092 void readAttributes() {
1094 std::set<std::string> read_attr;
1097 while (readLine() && line >> c && c != '@') {
1100 std::string attr, token;
1101 if (!_reader_bits::readToken(line, attr))
1102 throw FormatError("Attribute name not found");
1103 if (!_reader_bits::readToken(line, token))
1104 throw FormatError("Attribute value not found");
1106 throw FormatError("Extra character at the end of line");
1109 std::set<std::string>::iterator it = read_attr.find(attr);
1110 if (it != read_attr.end()) {
1111 std::ostringstream msg;
1112 msg << "Multiple occurence of attribute: " << attr;
1113 throw FormatError(msg.str());
1115 read_attr.insert(attr);
1119 typename Attributes::iterator it = _attributes.lower_bound(attr);
1120 while (it != _attributes.end() && it->first == attr) {
1121 it->second->set(token);
1127 if (readSuccess()) {
1130 for (typename Attributes::iterator it = _attributes.begin();
1131 it != _attributes.end(); ++it) {
1132 if (read_attr.find(it->first) == read_attr.end()) {
1133 std::ostringstream msg;
1134 msg << "Attribute not found: " << it->first;
1135 throw FormatError(msg.str());
1142 /// \name Execution of the reader
1145 /// \brief Start the batch processing
1147 /// This function starts the batch processing
1149 LEMON_ASSERT(_is != 0, "This reader assigned to an other reader");
1151 bool nodes_done = _skip_nodes;
1152 bool arcs_done = _skip_arcs;
1153 bool attributes_done = false;
1159 while (readSuccess()) {
1162 std::string section, caption;
1164 _reader_bits::readToken(line, section);
1165 _reader_bits::readToken(line, caption);
1168 throw FormatError("Extra character at the end of line");
1170 if (section == "nodes" && !nodes_done) {
1171 if (_nodes_caption.empty() || _nodes_caption == caption) {
1175 } else if ((section == "arcs" || section == "edges") &&
1177 if (_arcs_caption.empty() || _arcs_caption == caption) {
1181 } else if (section == "attributes" && !attributes_done) {
1182 if (_attributes_caption.empty() || _attributes_caption == caption) {
1184 attributes_done = true;
1190 } catch (FormatError& error) {
1191 error.line(line_num);
1192 error.file(_filename);
1198 throw FormatError("Section @nodes not found");
1202 throw FormatError("Section @arcs not found");
1205 if (!attributes_done && !_attributes.empty()) {
1206 throw FormatError("Section @attributes not found");
1215 template <typename Graph>
1218 /// \brief Return a \ref GraphReader class
1220 /// This function just returns a \ref GraphReader class.
1221 /// \relates GraphReader
1222 template <typename Graph>
1223 GraphReader<Graph> graphReader(Graph& graph, std::istream& is = std::cin) {
1224 GraphReader<Graph> tmp(graph, is);
1228 /// \brief Return a \ref GraphReader class
1230 /// This function just returns a \ref GraphReader class.
1231 /// \relates GraphReader
1232 template <typename Graph>
1233 GraphReader<Graph> graphReader(Graph& graph, const std::string& fn) {
1234 GraphReader<Graph> tmp(graph, fn);
1238 /// \brief Return a \ref GraphReader class
1240 /// This function just returns a \ref GraphReader class.
1241 /// \relates GraphReader
1242 template <typename Graph>
1243 GraphReader<Graph> graphReader(Graph& graph, const char* fn) {
1244 GraphReader<Graph> tmp(graph, fn);
1248 /// \ingroup lemon_io
1250 /// \brief \ref lgf-format "LGF" reader for undirected graphs
1252 /// This utility reads an \ref lgf-format "LGF" file.
1254 /// It can be used almost the same way as \c DigraphReader.
1255 /// The only difference is that this class can handle edges and
1256 /// edge maps as well as arcs and arc maps.
1258 /// The columns in the \c \@edges (or \c \@arcs) section are the
1259 /// edge maps. However, if there are two maps with the same name
1260 /// prefixed with \c '+' and \c '-', then these can be read into an
1261 /// arc map. Similarly, an attribute can be read into an arc, if
1262 /// it's value is an edge label prefixed with \c '+' or \c '-'.
1263 template <typename _Graph>
1267 typedef _Graph Graph;
1268 TEMPLATE_GRAPH_TYPEDEFS(Graph);
1274 std::string _filename;
1278 std::string _nodes_caption;
1279 std::string _edges_caption;
1280 std::string _attributes_caption;
1282 typedef std::map<std::string, Node> NodeIndex;
1283 NodeIndex _node_index;
1284 typedef std::map<std::string, Edge> EdgeIndex;
1285 EdgeIndex _edge_index;
1287 typedef std::vector<std::pair<std::string,
1288 _reader_bits::MapStorageBase<Node>*> > NodeMaps;
1289 NodeMaps _node_maps;
1291 typedef std::vector<std::pair<std::string,
1292 _reader_bits::MapStorageBase<Edge>*> > EdgeMaps;
1293 EdgeMaps _edge_maps;
1295 typedef std::multimap<std::string, _reader_bits::ValueStorageBase*>
1297 Attributes _attributes;
1306 std::istringstream line;
1310 /// \brief Constructor
1312 /// Construct an undirected graph reader, which reads from the given
1314 GraphReader(Graph& graph, std::istream& is = std::cin)
1315 : _is(&is), local_is(false), _graph(graph),
1316 _use_nodes(false), _use_edges(false),
1317 _skip_nodes(false), _skip_edges(false) {}
1319 /// \brief Constructor
1321 /// Construct an undirected graph reader, which reads from the given
1323 GraphReader(Graph& graph, const std::string& fn)
1324 : _is(new std::ifstream(fn.c_str())), local_is(true),
1325 _filename(fn), _graph(graph),
1326 _use_nodes(false), _use_edges(false),
1327 _skip_nodes(false), _skip_edges(false) {
1330 throw IoError("Cannot open file", fn);
1334 /// \brief Constructor
1336 /// Construct an undirected graph reader, which reads from the given
1338 GraphReader(Graph& graph, const char* fn)
1339 : _is(new std::ifstream(fn)), local_is(true),
1340 _filename(fn), _graph(graph),
1341 _use_nodes(false), _use_edges(false),
1342 _skip_nodes(false), _skip_edges(false) {
1345 throw IoError("Cannot open file", fn);
1349 /// \brief Destructor
1351 for (typename NodeMaps::iterator it = _node_maps.begin();
1352 it != _node_maps.end(); ++it) {
1356 for (typename EdgeMaps::iterator it = _edge_maps.begin();
1357 it != _edge_maps.end(); ++it) {
1361 for (typename Attributes::iterator it = _attributes.begin();
1362 it != _attributes.end(); ++it) {
1373 friend GraphReader<Graph> graphReader<>(Graph& graph, std::istream& is);
1374 friend GraphReader<Graph> graphReader<>(Graph& graph,
1375 const std::string& fn);
1376 friend GraphReader<Graph> graphReader<>(Graph& graph, const char *fn);
1378 GraphReader(GraphReader& other)
1379 : _is(other._is), local_is(other.local_is), _graph(other._graph),
1380 _use_nodes(other._use_nodes), _use_edges(other._use_edges),
1381 _skip_nodes(other._skip_nodes), _skip_edges(other._skip_edges) {
1384 other.local_is = false;
1386 _node_index.swap(other._node_index);
1387 _edge_index.swap(other._edge_index);
1389 _node_maps.swap(other._node_maps);
1390 _edge_maps.swap(other._edge_maps);
1391 _attributes.swap(other._attributes);
1393 _nodes_caption = other._nodes_caption;
1394 _edges_caption = other._edges_caption;
1395 _attributes_caption = other._attributes_caption;
1399 GraphReader& operator=(const GraphReader&);
1403 /// \name Reading rules
1406 /// \brief Node map reading rule
1408 /// Add a node map reading rule to the reader.
1409 template <typename Map>
1410 GraphReader& nodeMap(const std::string& caption, Map& map) {
1411 checkConcept<concepts::WriteMap<Node, typename Map::Value>, Map>();
1412 _reader_bits::MapStorageBase<Node>* storage =
1413 new _reader_bits::MapStorage<Node, Map>(map);
1414 _node_maps.push_back(std::make_pair(caption, storage));
1418 /// \brief Node map reading rule
1420 /// Add a node map reading rule with specialized converter to the
1422 template <typename Map, typename Converter>
1423 GraphReader& nodeMap(const std::string& caption, Map& map,
1424 const Converter& converter = Converter()) {
1425 checkConcept<concepts::WriteMap<Node, typename Map::Value>, Map>();
1426 _reader_bits::MapStorageBase<Node>* storage =
1427 new _reader_bits::MapStorage<Node, Map, Converter>(map, converter);
1428 _node_maps.push_back(std::make_pair(caption, storage));
1432 /// \brief Edge map reading rule
1434 /// Add an edge map reading rule to the reader.
1435 template <typename Map>
1436 GraphReader& edgeMap(const std::string& caption, Map& map) {
1437 checkConcept<concepts::WriteMap<Edge, typename Map::Value>, Map>();
1438 _reader_bits::MapStorageBase<Edge>* storage =
1439 new _reader_bits::MapStorage<Edge, Map>(map);
1440 _edge_maps.push_back(std::make_pair(caption, storage));
1444 /// \brief Edge map reading rule
1446 /// Add an edge map reading rule with specialized converter to the
1448 template <typename Map, typename Converter>
1449 GraphReader& edgeMap(const std::string& caption, Map& map,
1450 const Converter& converter = Converter()) {
1451 checkConcept<concepts::WriteMap<Edge, typename Map::Value>, Map>();
1452 _reader_bits::MapStorageBase<Edge>* storage =
1453 new _reader_bits::MapStorage<Edge, Map, Converter>(map, converter);
1454 _edge_maps.push_back(std::make_pair(caption, storage));
1458 /// \brief Arc map reading rule
1460 /// Add an arc map reading rule to the reader.
1461 template <typename Map>
1462 GraphReader& arcMap(const std::string& caption, Map& map) {
1463 checkConcept<concepts::WriteMap<Arc, typename Map::Value>, Map>();
1464 _reader_bits::MapStorageBase<Edge>* forward_storage =
1465 new _reader_bits::GraphArcMapStorage<Graph, true, Map>(_graph, map);
1466 _edge_maps.push_back(std::make_pair('+' + caption, forward_storage));
1467 _reader_bits::MapStorageBase<Edge>* backward_storage =
1468 new _reader_bits::GraphArcMapStorage<Graph, false, Map>(_graph, map);
1469 _edge_maps.push_back(std::make_pair('-' + caption, backward_storage));
1473 /// \brief Arc map reading rule
1475 /// Add an arc map reading rule with specialized converter to the
1477 template <typename Map, typename Converter>
1478 GraphReader& arcMap(const std::string& caption, Map& map,
1479 const Converter& converter = Converter()) {
1480 checkConcept<concepts::WriteMap<Arc, typename Map::Value>, Map>();
1481 _reader_bits::MapStorageBase<Edge>* forward_storage =
1482 new _reader_bits::GraphArcMapStorage<Graph, true, Map, Converter>
1483 (_graph, map, converter);
1484 _edge_maps.push_back(std::make_pair('+' + caption, forward_storage));
1485 _reader_bits::MapStorageBase<Edge>* backward_storage =
1486 new _reader_bits::GraphArcMapStorage<Graph, false, Map, Converter>
1487 (_graph, map, converter);
1488 _edge_maps.push_back(std::make_pair('-' + caption, backward_storage));
1492 /// \brief Attribute reading rule
1494 /// Add an attribute reading rule to the reader.
1495 template <typename Value>
1496 GraphReader& attribute(const std::string& caption, Value& value) {
1497 _reader_bits::ValueStorageBase* storage =
1498 new _reader_bits::ValueStorage<Value>(value);
1499 _attributes.insert(std::make_pair(caption, storage));
1503 /// \brief Attribute reading rule
1505 /// Add an attribute reading rule with specialized converter to the
1507 template <typename Value, typename Converter>
1508 GraphReader& attribute(const std::string& caption, Value& value,
1509 const Converter& converter = Converter()) {
1510 _reader_bits::ValueStorageBase* storage =
1511 new _reader_bits::ValueStorage<Value, Converter>(value, converter);
1512 _attributes.insert(std::make_pair(caption, storage));
1516 /// \brief Node reading rule
1518 /// Add a node reading rule to reader.
1519 GraphReader& node(const std::string& caption, Node& node) {
1520 typedef _reader_bits::MapLookUpConverter<Node> Converter;
1521 Converter converter(_node_index);
1522 _reader_bits::ValueStorageBase* storage =
1523 new _reader_bits::ValueStorage<Node, Converter>(node, converter);
1524 _attributes.insert(std::make_pair(caption, storage));
1528 /// \brief Edge reading rule
1530 /// Add an edge reading rule to reader.
1531 GraphReader& edge(const std::string& caption, Edge& edge) {
1532 typedef _reader_bits::MapLookUpConverter<Edge> Converter;
1533 Converter converter(_edge_index);
1534 _reader_bits::ValueStorageBase* storage =
1535 new _reader_bits::ValueStorage<Edge, Converter>(edge, converter);
1536 _attributes.insert(std::make_pair(caption, storage));
1540 /// \brief Arc reading rule
1542 /// Add an arc reading rule to reader.
1543 GraphReader& arc(const std::string& caption, Arc& arc) {
1544 typedef _reader_bits::GraphArcLookUpConverter<Graph> Converter;
1545 Converter converter(_graph, _edge_index);
1546 _reader_bits::ValueStorageBase* storage =
1547 new _reader_bits::ValueStorage<Arc, Converter>(arc, converter);
1548 _attributes.insert(std::make_pair(caption, storage));
1554 /// \name Select section by name
1557 /// \brief Set \c \@nodes section to be read
1559 /// Set \c \@nodes section to be read.
1560 GraphReader& nodes(const std::string& caption) {
1561 _nodes_caption = caption;
1565 /// \brief Set \c \@edges section to be read
1567 /// Set \c \@edges section to be read.
1568 GraphReader& edges(const std::string& caption) {
1569 _edges_caption = caption;
1573 /// \brief Set \c \@attributes section to be read
1575 /// Set \c \@attributes section to be read.
1576 GraphReader& attributes(const std::string& caption) {
1577 _attributes_caption = caption;
1583 /// \name Using previously constructed node or edge set
1586 /// \brief Use previously constructed node set
1588 /// Use previously constructed node set, and specify the node
1590 template <typename Map>
1591 GraphReader& useNodes(const Map& map) {
1592 checkConcept<concepts::ReadMap<Node, typename Map::Value>, Map>();
1593 LEMON_ASSERT(!_use_nodes, "Multiple usage of useNodes() member");
1595 _writer_bits::DefaultConverter<typename Map::Value> converter;
1596 for (NodeIt n(_graph); n != INVALID; ++n) {
1597 _node_index.insert(std::make_pair(converter(map[n]), n));
1602 /// \brief Use previously constructed node set
1604 /// Use previously constructed node set, and specify the node
1605 /// label map and a functor which converts the label map values to
1607 template <typename Map, typename Converter>
1608 GraphReader& useNodes(const Map& map,
1609 const Converter& converter = Converter()) {
1610 checkConcept<concepts::ReadMap<Node, typename Map::Value>, Map>();
1611 LEMON_ASSERT(!_use_nodes, "Multiple usage of useNodes() member");
1613 for (NodeIt n(_graph); n != INVALID; ++n) {
1614 _node_index.insert(std::make_pair(converter(map[n]), n));
1619 /// \brief Use previously constructed edge set
1621 /// Use previously constructed edge set, and specify the edge
1623 template <typename Map>
1624 GraphReader& useEdges(const Map& map) {
1625 checkConcept<concepts::ReadMap<Edge, typename Map::Value>, Map>();
1626 LEMON_ASSERT(!_use_edges, "Multiple usage of useEdges() member");
1628 _writer_bits::DefaultConverter<typename Map::Value> converter;
1629 for (EdgeIt a(_graph); a != INVALID; ++a) {
1630 _edge_index.insert(std::make_pair(converter(map[a]), a));
1635 /// \brief Use previously constructed edge set
1637 /// Use previously constructed edge set, and specify the edge
1638 /// label map and a functor which converts the label map values to
1640 template <typename Map, typename Converter>
1641 GraphReader& useEdges(const Map& map,
1642 const Converter& converter = Converter()) {
1643 checkConcept<concepts::ReadMap<Edge, typename Map::Value>, Map>();
1644 LEMON_ASSERT(!_use_edges, "Multiple usage of useEdges() member");
1646 for (EdgeIt a(_graph); a != INVALID; ++a) {
1647 _edge_index.insert(std::make_pair(converter(map[a]), a));
1652 /// \brief Skip the reading of node section
1654 /// Omit the reading of the node section. This implies that each node
1655 /// map reading rule will be abandoned, and the nodes of the graph
1656 /// will not be constructed, which usually cause that the edge set
1657 /// could not be read due to lack of node name
1658 /// could not be read due to lack of node name resolving.
1659 /// Therefore \c skipEdges() function should also be used, or
1660 /// \c useNodes() should be used to specify the label of the nodes.
1661 GraphReader& skipNodes() {
1662 LEMON_ASSERT(!_skip_nodes, "Skip nodes already set");
1667 /// \brief Skip the reading of edge section
1669 /// Omit the reading of the edge section. This implies that each edge
1670 /// map reading rule will be abandoned, and the edges of the graph
1671 /// will not be constructed.
1672 GraphReader& skipEdges() {
1673 LEMON_ASSERT(!_skip_edges, "Skip edges already set");
1684 while(++line_num, std::getline(*_is, str)) {
1685 line.clear(); line.str(str);
1687 if (line >> std::ws >> c && c != '#') {
1695 bool readSuccess() {
1696 return static_cast<bool>(*_is);
1699 void skipSection() {
1701 while (readSuccess() && line >> c && c != '@') {
1704 if (readSuccess()) {
1711 std::vector<int> map_index(_node_maps.size());
1712 int map_num, label_index;
1715 if (!readLine() || !(line >> c) || c == '@') {
1716 if (readSuccess() && line) line.putback(c);
1717 if (!_node_maps.empty())
1718 throw FormatError("Cannot find map names");
1724 std::map<std::string, int> maps;
1728 while (_reader_bits::readToken(line, map)) {
1729 if (maps.find(map) != maps.end()) {
1730 std::ostringstream msg;
1731 msg << "Multiple occurence of node map: " << map;
1732 throw FormatError(msg.str());
1734 maps.insert(std::make_pair(map, index));
1738 for (int i = 0; i < static_cast<int>(_node_maps.size()); ++i) {
1739 std::map<std::string, int>::iterator jt =
1740 maps.find(_node_maps[i].first);
1741 if (jt == maps.end()) {
1742 std::ostringstream msg;
1743 msg << "Map not found: " << _node_maps[i].first;
1744 throw FormatError(msg.str());
1746 map_index[i] = jt->second;
1750 std::map<std::string, int>::iterator jt = maps.find("label");
1751 if (jt != maps.end()) {
1752 label_index = jt->second;
1757 map_num = maps.size();
1760 while (readLine() && line >> c && c != '@') {
1763 std::vector<std::string> tokens(map_num);
1764 for (int i = 0; i < map_num; ++i) {
1765 if (!_reader_bits::readToken(line, tokens[i])) {
1766 std::ostringstream msg;
1767 msg << "Column not found (" << i + 1 << ")";
1768 throw FormatError(msg.str());
1771 if (line >> std::ws >> c)
1772 throw FormatError("Extra character at the end of line");
1776 n = _graph.addNode();
1777 if (label_index != -1)
1778 _node_index.insert(std::make_pair(tokens[label_index], n));
1780 if (label_index == -1)
1781 throw FormatError("Label map not found");
1782 typename std::map<std::string, Node>::iterator it =
1783 _node_index.find(tokens[label_index]);
1784 if (it == _node_index.end()) {
1785 std::ostringstream msg;
1786 msg << "Node with label not found: " << tokens[label_index];
1787 throw FormatError(msg.str());
1792 for (int i = 0; i < static_cast<int>(_node_maps.size()); ++i) {
1793 _node_maps[i].second->set(n, tokens[map_index[i]]);
1797 if (readSuccess()) {
1804 std::vector<int> map_index(_edge_maps.size());
1805 int map_num, label_index;
1808 if (!readLine() || !(line >> c) || c == '@') {
1809 if (readSuccess() && line) line.putback(c);
1810 if (!_edge_maps.empty())
1811 throw FormatError("Cannot find map names");
1817 std::map<std::string, int> maps;
1821 while (_reader_bits::readToken(line, map)) {
1822 if (maps.find(map) != maps.end()) {
1823 std::ostringstream msg;
1824 msg << "Multiple occurence of edge map: " << map;
1825 throw FormatError(msg.str());
1827 maps.insert(std::make_pair(map, index));
1831 for (int i = 0; i < static_cast<int>(_edge_maps.size()); ++i) {
1832 std::map<std::string, int>::iterator jt =
1833 maps.find(_edge_maps[i].first);
1834 if (jt == maps.end()) {
1835 std::ostringstream msg;
1836 msg << "Map not found: " << _edge_maps[i].first;
1837 throw FormatError(msg.str());
1839 map_index[i] = jt->second;
1843 std::map<std::string, int>::iterator jt = maps.find("label");
1844 if (jt != maps.end()) {
1845 label_index = jt->second;
1850 map_num = maps.size();
1853 while (readLine() && line >> c && c != '@') {
1856 std::string source_token;
1857 std::string target_token;
1859 if (!_reader_bits::readToken(line, source_token))
1860 throw FormatError("Node u not found");
1862 if (!_reader_bits::readToken(line, target_token))
1863 throw FormatError("Node v not found");
1865 std::vector<std::string> tokens(map_num);
1866 for (int i = 0; i < map_num; ++i) {
1867 if (!_reader_bits::readToken(line, tokens[i])) {
1868 std::ostringstream msg;
1869 msg << "Column not found (" << i + 1 << ")";
1870 throw FormatError(msg.str());
1873 if (line >> std::ws >> c)
1874 throw FormatError("Extra character at the end of line");
1879 typename NodeIndex::iterator it;
1881 it = _node_index.find(source_token);
1882 if (it == _node_index.end()) {
1883 std::ostringstream msg;
1884 msg << "Item not found: " << source_token;
1885 throw FormatError(msg.str());
1887 Node source = it->second;
1889 it = _node_index.find(target_token);
1890 if (it == _node_index.end()) {
1891 std::ostringstream msg;
1892 msg << "Item not found: " << target_token;
1893 throw FormatError(msg.str());
1895 Node target = it->second;
1897 e = _graph.addEdge(source, target);
1898 if (label_index != -1)
1899 _edge_index.insert(std::make_pair(tokens[label_index], e));
1901 if (label_index == -1)
1902 throw FormatError("Label map not found");
1903 typename std::map<std::string, Edge>::iterator it =
1904 _edge_index.find(tokens[label_index]);
1905 if (it == _edge_index.end()) {
1906 std::ostringstream msg;
1907 msg << "Edge with label not found: " << tokens[label_index];
1908 throw FormatError(msg.str());
1913 for (int i = 0; i < static_cast<int>(_edge_maps.size()); ++i) {
1914 _edge_maps[i].second->set(e, tokens[map_index[i]]);
1918 if (readSuccess()) {
1923 void readAttributes() {
1925 std::set<std::string> read_attr;
1928 while (readLine() && line >> c && c != '@') {
1931 std::string attr, token;
1932 if (!_reader_bits::readToken(line, attr))
1933 throw FormatError("Attribute name not found");
1934 if (!_reader_bits::readToken(line, token))
1935 throw FormatError("Attribute value not found");
1937 throw FormatError("Extra character at the end of line");
1940 std::set<std::string>::iterator it = read_attr.find(attr);
1941 if (it != read_attr.end()) {
1942 std::ostringstream msg;
1943 msg << "Multiple occurence of attribute: " << attr;
1944 throw FormatError(msg.str());
1946 read_attr.insert(attr);
1950 typename Attributes::iterator it = _attributes.lower_bound(attr);
1951 while (it != _attributes.end() && it->first == attr) {
1952 it->second->set(token);
1958 if (readSuccess()) {
1961 for (typename Attributes::iterator it = _attributes.begin();
1962 it != _attributes.end(); ++it) {
1963 if (read_attr.find(it->first) == read_attr.end()) {
1964 std::ostringstream msg;
1965 msg << "Attribute not found: " << it->first;
1966 throw FormatError(msg.str());
1973 /// \name Execution of the reader
1976 /// \brief Start the batch processing
1978 /// This function starts the batch processing
1981 LEMON_ASSERT(_is != 0, "This reader assigned to an other reader");
1983 bool nodes_done = _skip_nodes;
1984 bool edges_done = _skip_edges;
1985 bool attributes_done = false;
1991 while (readSuccess()) {
1994 std::string section, caption;
1996 _reader_bits::readToken(line, section);
1997 _reader_bits::readToken(line, caption);
2000 throw FormatError("Extra character at the end of line");
2002 if (section == "nodes" && !nodes_done) {
2003 if (_nodes_caption.empty() || _nodes_caption == caption) {
2007 } else if ((section == "edges" || section == "arcs") &&
2009 if (_edges_caption.empty() || _edges_caption == caption) {
2013 } else if (section == "attributes" && !attributes_done) {
2014 if (_attributes_caption.empty() || _attributes_caption == caption) {
2016 attributes_done = true;
2022 } catch (FormatError& error) {
2023 error.line(line_num);
2024 error.file(_filename);
2030 throw FormatError("Section @nodes not found");
2034 throw FormatError("Section @edges not found");
2037 if (!attributes_done && !_attributes.empty()) {
2038 throw FormatError("Section @attributes not found");
2047 class SectionReader;
2049 SectionReader sectionReader(std::istream& is);
2050 SectionReader sectionReader(const std::string& fn);
2051 SectionReader sectionReader(const char* fn);
2053 /// \ingroup lemon_io
2055 /// \brief Section reader class
2057 /// In the \ref lgf-format "LGF" file extra sections can be placed,
2058 /// which contain any data in arbitrary format. Such sections can be
2059 /// read with this class. A reading rule can be added to the class
2060 /// with two different functions. With the \c sectionLines() function a
2061 /// functor can process the section line-by-line, while with the \c
2062 /// sectionStream() member the section can be read from an input
2064 class SectionReader {
2069 std::string _filename;
2071 typedef std::map<std::string, _reader_bits::Section*> Sections;
2075 std::istringstream line;
2079 /// \brief Constructor
2081 /// Construct a section reader, which reads from the given input
2083 SectionReader(std::istream& is)
2084 : _is(&is), local_is(false) {}
2086 /// \brief Constructor
2088 /// Construct a section reader, which reads from the given file.
2089 SectionReader(const std::string& fn)
2090 : _is(new std::ifstream(fn.c_str())), local_is(true),
2094 throw IoError("Cannot open file", fn);
2098 /// \brief Constructor
2100 /// Construct a section reader, which reads from the given file.
2101 SectionReader(const char* fn)
2102 : _is(new std::ifstream(fn)), local_is(true),
2106 throw IoError("Cannot open file", fn);
2110 /// \brief Destructor
2112 for (Sections::iterator it = _sections.begin();
2113 it != _sections.end(); ++it) {
2125 friend SectionReader sectionReader(std::istream& is);
2126 friend SectionReader sectionReader(const std::string& fn);
2127 friend SectionReader sectionReader(const char* fn);
2129 SectionReader(SectionReader& other)
2130 : _is(other._is), local_is(other.local_is) {
2133 other.local_is = false;
2135 _sections.swap(other._sections);
2138 SectionReader& operator=(const SectionReader&);
2142 /// \name Section readers
2145 /// \brief Add a section processor with line oriented reading
2147 /// The first parameter is the type descriptor of the section, the
2148 /// second is a functor, which takes just one \c std::string
2149 /// parameter. At the reading process, each line of the section
2150 /// will be given to the functor object. However, the empty lines
2151 /// and the comment lines are filtered out, and the leading
2152 /// whitespaces are trimmed from each processed string.
2154 /// For example let's see a section, which contain several
2155 /// integers, which should be inserted into a vector.
2163 /// The functor is implemented as a struct:
2165 /// struct NumberSection {
2166 /// std::vector<int>& _data;
2167 /// NumberSection(std::vector<int>& data) : _data(data) {}
2168 /// void operator()(const std::string& line) {
2169 /// std::istringstream ls(line);
2171 /// while (ls >> value) _data.push_back(value);
2177 /// reader.sectionLines("numbers", NumberSection(vec));
2179 template <typename Functor>
2180 SectionReader& sectionLines(const std::string& type, Functor functor) {
2181 LEMON_ASSERT(!type.empty(), "Type is empty.");
2182 LEMON_ASSERT(_sections.find(type) == _sections.end(),
2183 "Multiple reading of section.");
2184 _sections.insert(std::make_pair(type,
2185 new _reader_bits::LineSection<Functor>(functor)));
2190 /// \brief Add a section processor with stream oriented reading
2192 /// The first parameter is the type of the section, the second is
2193 /// a functor, which takes an \c std::istream& and an \c int&
2194 /// parameter, the latter regard to the line number of stream. The
2195 /// functor can read the input while the section go on, and the
2196 /// line number should be modified accordingly.
2197 template <typename Functor>
2198 SectionReader& sectionStream(const std::string& type, Functor functor) {
2199 LEMON_ASSERT(!type.empty(), "Type is empty.");
2200 LEMON_ASSERT(_sections.find(type) == _sections.end(),
2201 "Multiple reading of section.");
2202 _sections.insert(std::make_pair(type,
2203 new _reader_bits::StreamSection<Functor>(functor)));
2213 while(++line_num, std::getline(*_is, str)) {
2214 line.clear(); line.str(str);
2216 if (line >> std::ws >> c && c != '#') {
2224 bool readSuccess() {
2225 return static_cast<bool>(*_is);
2228 void skipSection() {
2230 while (readSuccess() && line >> c && c != '@') {
2233 if (readSuccess()) {
2241 /// \name Execution of the reader
2244 /// \brief Start the batch processing
2246 /// This function starts the batch processing.
2249 LEMON_ASSERT(_is != 0, "This reader assigned to an other reader");
2251 std::set<std::string> extra_sections;
2257 while (readSuccess()) {
2260 std::string section, caption;
2262 _reader_bits::readToken(line, section);
2263 _reader_bits::readToken(line, caption);
2266 throw FormatError("Extra character at the end of line");
2268 if (extra_sections.find(section) != extra_sections.end()) {
2269 std::ostringstream msg;
2270 msg << "Multiple occurence of section: " << section;
2271 throw FormatError(msg.str());
2273 Sections::iterator it = _sections.find(section);
2274 if (it != _sections.end()) {
2275 extra_sections.insert(section);
2276 it->second->process(*_is, line_num);
2280 } catch (FormatError& error) {
2281 error.line(line_num);
2282 error.file(_filename);
2286 for (Sections::iterator it = _sections.begin();
2287 it != _sections.end(); ++it) {
2288 if (extra_sections.find(it->first) == extra_sections.end()) {
2289 std::ostringstream os;
2290 os << "Cannot find section: " << it->first;
2291 throw FormatError(os.str());
2300 /// \brief Return a \ref SectionReader class
2302 /// This function just returns a \ref SectionReader class.
2303 /// \relates SectionReader
2304 inline SectionReader sectionReader(std::istream& is) {
2305 SectionReader tmp(is);
2309 /// \brief Return a \ref SectionReader class
2311 /// This function just returns a \ref SectionReader class.
2312 /// \relates SectionReader
2313 inline SectionReader sectionReader(const std::string& fn) {
2314 SectionReader tmp(fn);
2318 /// \brief Return a \ref SectionReader class
2320 /// This function just returns a \ref SectionReader class.
2321 /// \relates SectionReader
2322 inline SectionReader sectionReader(const char* fn) {
2323 SectionReader tmp(fn);
2327 /// \ingroup lemon_io
2329 /// \brief Reader for the contents of the \ref lgf-format "LGF" file
2331 /// This class can be used to read the sections, the map names and
2332 /// the attributes from a file. Usually, the LEMON programs know
2333 /// that, which type of graph, which maps and which attributes
2334 /// should be read from a file, but in general tools (like glemon)
2335 /// the contents of an LGF file should be guessed somehow. This class
2336 /// reads the graph and stores the appropriate information for
2337 /// reading the graph.
2340 /// LgfContents contents("graph.lgf");
2343 /// // Does it contain any node section and arc section?
2344 /// if (contents.nodeSectionNum() == 0 || contents.arcSectionNum()) {
2345 /// std::cerr << "Failure, cannot find graph." << std::endl;
2348 /// std::cout << "The name of the default node section: "
2349 /// << contents.nodeSection(0) << std::endl;
2350 /// std::cout << "The number of the arc maps: "
2351 /// << contents.arcMaps(0).size() << std::endl;
2352 /// std::cout << "The name of second arc map: "
2353 /// << contents.arcMaps(0)[1] << std::endl;
2361 std::vector<std::string> _node_sections;
2362 std::vector<std::string> _edge_sections;
2363 std::vector<std::string> _attribute_sections;
2364 std::vector<std::string> _extra_sections;
2366 std::vector<bool> _arc_sections;
2368 std::vector<std::vector<std::string> > _node_maps;
2369 std::vector<std::vector<std::string> > _edge_maps;
2371 std::vector<std::vector<std::string> > _attributes;
2375 std::istringstream line;
2379 /// \brief Constructor
2381 /// Construct an \e LGF contents reader, which reads from the given
2383 LgfContents(std::istream& is)
2384 : _is(&is), local_is(false) {}
2386 /// \brief Constructor
2388 /// Construct an \e LGF contents reader, which reads from the given
2390 LgfContents(const std::string& fn)
2391 : _is(new std::ifstream(fn.c_str())), local_is(true) {
2394 throw IoError("Cannot open file", fn);
2398 /// \brief Constructor
2400 /// Construct an \e LGF contents reader, which reads from the given
2402 LgfContents(const char* fn)
2403 : _is(new std::ifstream(fn)), local_is(true) {
2406 throw IoError("Cannot open file", fn);
2410 /// \brief Destructor
2412 if (local_is) delete _is;
2417 LgfContents(const LgfContents&);
2418 LgfContents& operator=(const LgfContents&);
2423 /// \name Node sections
2426 /// \brief Gives back the number of node sections in the file.
2428 /// Gives back the number of node sections in the file.
2429 int nodeSectionNum() const {
2430 return _node_sections.size();
2433 /// \brief Returns the node section name at the given position.
2435 /// Returns the node section name at the given position.
2436 const std::string& nodeSection(int i) const {
2437 return _node_sections[i];
2440 /// \brief Gives back the node maps for the given section.
2442 /// Gives back the node maps for the given section.
2443 const std::vector<std::string>& nodeMapNames(int i) const {
2444 return _node_maps[i];
2449 /// \name Arc/Edge sections
2452 /// \brief Gives back the number of arc/edge sections in the file.
2454 /// Gives back the number of arc/edge sections in the file.
2455 /// \note It is synonym of \c edgeSectionNum().
2456 int arcSectionNum() const {
2457 return _edge_sections.size();
2460 /// \brief Returns the arc/edge section name at the given position.
2462 /// Returns the arc/edge section name at the given position.
2463 /// \note It is synonym of \c edgeSection().
2464 const std::string& arcSection(int i) const {
2465 return _edge_sections[i];
2468 /// \brief Gives back the arc/edge maps for the given section.
2470 /// Gives back the arc/edge maps for the given section.
2471 /// \note It is synonym of \c edgeMapNames().
2472 const std::vector<std::string>& arcMapNames(int i) const {
2473 return _edge_maps[i];
2481 /// \brief Gives back the number of arc/edge sections in the file.
2483 /// Gives back the number of arc/edge sections in the file.
2484 /// \note It is synonym of \c arcSectionNum().
2485 int edgeSectionNum() const {
2486 return _edge_sections.size();
2489 /// \brief Returns the section name at the given position.
2491 /// Returns the section name at the given position.
2492 /// \note It is synonym of \c arcSection().
2493 const std::string& edgeSection(int i) const {
2494 return _edge_sections[i];
2497 /// \brief Gives back the edge maps for the given section.
2499 /// Gives back the edge maps for the given section.
2500 /// \note It is synonym of \c arcMapNames().
2501 const std::vector<std::string>& edgeMapNames(int i) const {
2502 return _edge_maps[i];
2507 /// \name Attribute sections
2510 /// \brief Gives back the number of attribute sections in the file.
2512 /// Gives back the number of attribute sections in the file.
2513 int attributeSectionNum() const {
2514 return _attribute_sections.size();
2517 /// \brief Returns the attribute section name at the given position.
2519 /// Returns the attribute section name at the given position.
2520 const std::string& attributeSectionNames(int i) const {
2521 return _attribute_sections[i];
2524 /// \brief Gives back the attributes for the given section.
2526 /// Gives back the attributes for the given section.
2527 const std::vector<std::string>& attributes(int i) const {
2528 return _attributes[i];
2533 /// \name Extra sections
2536 /// \brief Gives back the number of extra sections in the file.
2538 /// Gives back the number of extra sections in the file.
2539 int extraSectionNum() const {
2540 return _extra_sections.size();
2543 /// \brief Returns the extra section type at the given position.
2545 /// Returns the section type at the given position.
2546 const std::string& extraSection(int i) const {
2547 return _extra_sections[i];
2556 while(++line_num, std::getline(*_is, str)) {
2557 line.clear(); line.str(str);
2559 if (line >> std::ws >> c && c != '#') {
2567 bool readSuccess() {
2568 return static_cast<bool>(*_is);
2571 void skipSection() {
2573 while (readSuccess() && line >> c && c != '@') {
2576 if (readSuccess()) {
2581 void readMaps(std::vector<std::string>& maps) {
2583 if (!readLine() || !(line >> c) || c == '@') {
2584 if (readSuccess() && line) line.putback(c);
2589 while (_reader_bits::readToken(line, map)) {
2590 maps.push_back(map);
2594 void readAttributes(std::vector<std::string>& attrs) {
2597 while (readSuccess() && line >> c && c != '@') {
2600 _reader_bits::readToken(line, attr);
2601 attrs.push_back(attr);
2609 /// \name Execution of the contents reader
2612 /// \brief Starts the reading
2614 /// This function starts the reading.
2620 while (readSuccess()) {
2625 std::string section, caption;
2626 _reader_bits::readToken(line, section);
2627 _reader_bits::readToken(line, caption);
2629 if (section == "nodes") {
2630 _node_sections.push_back(caption);
2631 _node_maps.push_back(std::vector<std::string>());
2632 readMaps(_node_maps.back());
2633 readLine(); skipSection();
2634 } else if (section == "arcs" || section == "edges") {
2635 _edge_sections.push_back(caption);
2636 _arc_sections.push_back(section == "arcs");
2637 _edge_maps.push_back(std::vector<std::string>());
2638 readMaps(_edge_maps.back());
2639 readLine(); skipSection();
2640 } else if (section == "attributes") {
2641 _attribute_sections.push_back(caption);
2642 _attributes.push_back(std::vector<std::string>());
2643 readAttributes(_attributes.back());
2645 _extra_sections.push_back(section);
2646 readLine(); skipSection();