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/assert.h>
35 #include <lemon/core.h>
37 #include <lemon/lgf_writer.h>
39 #include <lemon/concept_check.h>
40 #include <lemon/concepts/maps.h>
44 namespace _reader_bits {
46 template <typename Value>
47 struct DefaultConverter {
48 Value operator()(const std::string& str) {
49 std::istringstream is(str);
52 throw FormatError("Cannot read token");
56 if (is >> std::ws >> c) {
57 throw FormatError("Remaining characters in token");
64 struct DefaultConverter<std::string> {
65 std::string operator()(const std::string& str) {
70 template <typename _Item>
71 class MapStorageBase {
77 virtual ~MapStorageBase() {}
79 virtual void set(const Item& item, const std::string& value) = 0;
83 template <typename _Item, typename _Map,
84 typename _Converter = DefaultConverter<typename _Map::Value> >
85 class MapStorage : public MapStorageBase<_Item> {
88 typedef _Converter Converter;
96 MapStorage(Map& map, const Converter& converter = Converter())
97 : _map(map), _converter(converter) {}
98 virtual ~MapStorage() {}
100 virtual void set(const Item& item ,const std::string& value) {
101 _map.set(item, _converter(value));
105 template <typename _Graph, bool _dir, typename _Map,
106 typename _Converter = DefaultConverter<typename _Map::Value> >
107 class GraphArcMapStorage : public MapStorageBase<typename _Graph::Edge> {
110 typedef _Converter Converter;
111 typedef _Graph Graph;
112 typedef typename Graph::Edge Item;
113 static const bool dir = _dir;
118 Converter _converter;
121 GraphArcMapStorage(const Graph& graph, Map& map,
122 const Converter& converter = Converter())
123 : _graph(graph), _map(map), _converter(converter) {}
124 virtual ~GraphArcMapStorage() {}
126 virtual void set(const Item& item ,const std::string& value) {
127 _map.set(_graph.direct(item, dir), _converter(value));
131 class ValueStorageBase {
133 ValueStorageBase() {}
134 virtual ~ValueStorageBase() {}
136 virtual void set(const std::string&) = 0;
139 template <typename _Value, typename _Converter = DefaultConverter<_Value> >
140 class ValueStorage : public ValueStorageBase {
142 typedef _Value Value;
143 typedef _Converter Converter;
147 Converter _converter;
150 ValueStorage(Value& value, const Converter& converter = Converter())
151 : _value(value), _converter(converter) {}
153 virtual void set(const std::string& value) {
154 _value = _converter(value);
158 template <typename Value>
159 struct MapLookUpConverter {
160 const std::map<std::string, Value>& _map;
162 MapLookUpConverter(const std::map<std::string, Value>& map)
165 Value operator()(const std::string& str) {
166 typename std::map<std::string, Value>::const_iterator it =
168 if (it == _map.end()) {
169 std::ostringstream msg;
170 msg << "Item not found: " << str;
171 throw FormatError(msg.str());
177 template <typename Graph>
178 struct GraphArcLookUpConverter {
180 const std::map<std::string, typename Graph::Edge>& _map;
182 GraphArcLookUpConverter(const Graph& graph,
183 const std::map<std::string,
184 typename Graph::Edge>& map)
185 : _graph(graph), _map(map) {}
187 typename Graph::Arc operator()(const std::string& str) {
188 if (str.empty() || (str[0] != '+' && str[0] != '-')) {
189 throw FormatError("Item must start with '+' or '-'");
191 typename std::map<std::string, typename Graph::Edge>
192 ::const_iterator it = _map.find(str.substr(1));
193 if (it == _map.end()) {
194 throw FormatError("Item not found");
196 return _graph.direct(it->second, str[0] == '+');
200 inline bool isWhiteSpace(char c) {
201 return c == ' ' || c == '\t' || c == '\v' ||
202 c == '\n' || c == '\r' || c == '\f';
205 inline bool isOct(char c) {
206 return '0' <= c && c <='7';
209 inline int valueOct(char c) {
210 LEMON_ASSERT(isOct(c), "The character is not octal.");
214 inline bool isHex(char c) {
215 return ('0' <= c && c <= '9') ||
216 ('a' <= c && c <= 'z') ||
217 ('A' <= c && c <= 'Z');
220 inline int valueHex(char c) {
221 LEMON_ASSERT(isHex(c), "The character is not hexadecimal.");
222 if ('0' <= c && c <= '9') return c - '0';
223 if ('a' <= c && c <= 'z') return c - 'a' + 10;
227 inline bool isIdentifierFirstChar(char c) {
228 return ('a' <= c && c <= 'z') ||
229 ('A' <= c && c <= 'Z') || c == '_';
232 inline bool isIdentifierChar(char c) {
233 return isIdentifierFirstChar(c) ||
234 ('0' <= c && c <= '9');
237 inline char readEscape(std::istream& is) {
240 throw FormatError("Escape format error");
268 if (!is.get(c) || !isHex(c))
269 throw FormatError("Escape format error");
270 else if (code = valueHex(c), !is.get(c) || !isHex(c)) is.putback(c);
271 else code = code * 16 + valueHex(c);
278 throw FormatError("Escape format error");
279 else if (code = valueOct(c), !is.get(c) || !isOct(c))
281 else if (code = code * 8 + valueOct(c), !is.get(c) || !isOct(c))
283 else code = code * 8 + valueOct(c);
289 inline std::istream& readToken(std::istream& is, std::string& str) {
290 std::ostringstream os;
299 while (is.get(c) && c != '\"') {
305 throw FormatError("Quoted format error");
308 while (is.get(c) && !isWhiteSpace(c)) {
325 virtual ~Section() {}
326 virtual void process(std::istream& is, int& line_num) = 0;
329 template <typename Functor>
330 class LineSection : public Section {
337 LineSection(const Functor& functor) : _functor(functor) {}
338 virtual ~LineSection() {}
340 virtual void process(std::istream& is, int& line_num) {
343 while (is.get(c) && c != '@') {
346 } else if (c == '#') {
349 } else if (!isWhiteSpace(c)) {
356 if (is) is.putback(c);
357 else if (is.eof()) is.clear();
361 template <typename Functor>
362 class StreamSection : public Section {
369 StreamSection(const Functor& functor) : _functor(functor) {}
370 virtual ~StreamSection() {}
372 virtual void process(std::istream& is, int& line_num) {
373 _functor(is, line_num);
376 while (is.get(c) && c != '@') {
379 } else if (!isWhiteSpace(c)) {
384 if (is) is.putback(c);
385 else if (is.eof()) is.clear();
391 template <typename Digraph>
394 template <typename Digraph>
395 DigraphReader<Digraph> digraphReader(Digraph& digraph,
396 std::istream& is = std::cin);
398 template <typename Digraph>
399 DigraphReader<Digraph> digraphReader(Digraph& digraph, const std::string& fn);
401 template <typename Digraph>
402 DigraphReader<Digraph> digraphReader(Digraph& digraph, const char *fn);
404 /// \ingroup lemon_io
406 /// \brief \ref lgf-format "LGF" reader for directed graphs
408 /// This utility reads an \ref lgf-format "LGF" file.
410 /// The reading method does a batch processing. The user creates a
411 /// reader object, then various reading rules can be added to the
412 /// reader, and eventually the reading is executed with the \c run()
413 /// member function. A map reading rule can be added to the reader
414 /// with the \c nodeMap() or \c arcMap() members. An optional
415 /// converter parameter can also be added as a standard functor
416 /// converting from \c std::string to the value type of the map. If it
417 /// is set, it will determine how the tokens in the file should be
418 /// converted to the value type of the map. If the functor is not set,
419 /// then a default conversion will be used. One map can be read into
420 /// multiple map objects at the same time. The \c attribute(), \c
421 /// node() and \c arc() functions are used to add attribute reading
425 /// DigraphReader<Digraph>(digraph, std::cin).
426 /// nodeMap("coordinates", coord_map).
427 /// arcMap("capacity", cap_map).
428 /// node("source", src).
429 /// node("target", trg).
430 /// attribute("caption", caption).
434 /// By default the reader uses the first section in the file of the
435 /// proper type. If a section has an optional name, then it can be
436 /// selected for reading by giving an optional name parameter to the
437 /// \c nodes(), \c arcs() or \c attributes() functions.
439 /// The \c useNodes() and \c useArcs() functions are used to tell the reader
440 /// that the nodes or arcs should not be constructed (added to the
441 /// graph) during the reading, but instead the label map of the items
442 /// are given as a parameter of these functions. An
443 /// application of these functions is multipass reading, which is
444 /// important if two \c \@arcs sections must be read from the
445 /// file. In this case the first phase would read the node set and one
446 /// of the arc sets, while the second phase would read the second arc
447 /// set into an \e ArcSet class (\c SmartArcSet or \c ListArcSet).
448 /// The previously read label node map should be passed to the \c
449 /// useNodes() functions. Another application of multipass reading when
450 /// paths are given as a node map or an arc map.
451 /// It is impossible to read this in
452 /// a single pass, because the arcs are not constructed when the node
454 template <typename _Digraph>
455 class DigraphReader {
458 typedef _Digraph Digraph;
459 TEMPLATE_DIGRAPH_TYPEDEFS(Digraph);
466 std::string _filename;
470 std::string _nodes_caption;
471 std::string _arcs_caption;
472 std::string _attributes_caption;
474 typedef std::map<std::string, Node> NodeIndex;
475 NodeIndex _node_index;
476 typedef std::map<std::string, Arc> ArcIndex;
479 typedef std::vector<std::pair<std::string,
480 _reader_bits::MapStorageBase<Node>*> > NodeMaps;
483 typedef std::vector<std::pair<std::string,
484 _reader_bits::MapStorageBase<Arc>*> >ArcMaps;
487 typedef std::multimap<std::string, _reader_bits::ValueStorageBase*>
489 Attributes _attributes;
498 std::istringstream line;
502 /// \brief Constructor
504 /// Construct a directed graph reader, which reads from the given
506 DigraphReader(Digraph& digraph, std::istream& is = std::cin)
507 : _is(&is), local_is(false), _digraph(digraph),
508 _use_nodes(false), _use_arcs(false),
509 _skip_nodes(false), _skip_arcs(false) {}
511 /// \brief Constructor
513 /// Construct a directed graph reader, which reads from the given
515 DigraphReader(Digraph& digraph, const std::string& fn)
516 : _is(new std::ifstream(fn.c_str())), local_is(true),
517 _filename(fn), _digraph(digraph),
518 _use_nodes(false), _use_arcs(false),
519 _skip_nodes(false), _skip_arcs(false) {
522 throw IoError("Cannot open file", fn);
526 /// \brief Constructor
528 /// Construct a directed graph reader, which reads from the given
530 DigraphReader(Digraph& digraph, const char* fn)
531 : _is(new std::ifstream(fn)), local_is(true),
532 _filename(fn), _digraph(digraph),
533 _use_nodes(false), _use_arcs(false),
534 _skip_nodes(false), _skip_arcs(false) {
537 throw IoError("Cannot open file", fn);
541 /// \brief Destructor
543 for (typename NodeMaps::iterator it = _node_maps.begin();
544 it != _node_maps.end(); ++it) {
548 for (typename ArcMaps::iterator it = _arc_maps.begin();
549 it != _arc_maps.end(); ++it) {
553 for (typename Attributes::iterator it = _attributes.begin();
554 it != _attributes.end(); ++it) {
566 friend DigraphReader<Digraph> digraphReader<>(Digraph& digraph,
568 friend DigraphReader<Digraph> digraphReader<>(Digraph& digraph,
569 const std::string& fn);
570 friend DigraphReader<Digraph> digraphReader<>(Digraph& digraph,
573 DigraphReader(DigraphReader& other)
574 : _is(other._is), local_is(other.local_is), _digraph(other._digraph),
575 _use_nodes(other._use_nodes), _use_arcs(other._use_arcs),
576 _skip_nodes(other._skip_nodes), _skip_arcs(other._skip_arcs) {
579 other.local_is = false;
581 _node_index.swap(other._node_index);
582 _arc_index.swap(other._arc_index);
584 _node_maps.swap(other._node_maps);
585 _arc_maps.swap(other._arc_maps);
586 _attributes.swap(other._attributes);
588 _nodes_caption = other._nodes_caption;
589 _arcs_caption = other._arcs_caption;
590 _attributes_caption = other._attributes_caption;
594 DigraphReader& operator=(const DigraphReader&);
598 /// \name Reading rules
601 /// \brief Node map reading rule
603 /// Add a node map reading rule to the reader.
604 template <typename Map>
605 DigraphReader& nodeMap(const std::string& caption, Map& map) {
606 checkConcept<concepts::WriteMap<Node, typename Map::Value>, Map>();
607 _reader_bits::MapStorageBase<Node>* storage =
608 new _reader_bits::MapStorage<Node, Map>(map);
609 _node_maps.push_back(std::make_pair(caption, storage));
613 /// \brief Node map reading rule
615 /// Add a node map reading rule with specialized converter to the
617 template <typename Map, typename Converter>
618 DigraphReader& nodeMap(const std::string& caption, Map& map,
619 const Converter& converter = Converter()) {
620 checkConcept<concepts::WriteMap<Node, typename Map::Value>, Map>();
621 _reader_bits::MapStorageBase<Node>* storage =
622 new _reader_bits::MapStorage<Node, Map, Converter>(map, converter);
623 _node_maps.push_back(std::make_pair(caption, storage));
627 /// \brief Arc map reading rule
629 /// Add an arc map reading rule to the reader.
630 template <typename Map>
631 DigraphReader& arcMap(const std::string& caption, Map& map) {
632 checkConcept<concepts::WriteMap<Arc, typename Map::Value>, Map>();
633 _reader_bits::MapStorageBase<Arc>* storage =
634 new _reader_bits::MapStorage<Arc, Map>(map);
635 _arc_maps.push_back(std::make_pair(caption, storage));
639 /// \brief Arc map reading rule
641 /// Add an arc map reading rule with specialized converter to the
643 template <typename Map, typename Converter>
644 DigraphReader& arcMap(const std::string& caption, Map& map,
645 const Converter& converter = Converter()) {
646 checkConcept<concepts::WriteMap<Arc, typename Map::Value>, Map>();
647 _reader_bits::MapStorageBase<Arc>* storage =
648 new _reader_bits::MapStorage<Arc, Map, Converter>(map, converter);
649 _arc_maps.push_back(std::make_pair(caption, storage));
653 /// \brief Attribute reading rule
655 /// Add an attribute reading rule to the reader.
656 template <typename Value>
657 DigraphReader& attribute(const std::string& caption, Value& value) {
658 _reader_bits::ValueStorageBase* storage =
659 new _reader_bits::ValueStorage<Value>(value);
660 _attributes.insert(std::make_pair(caption, storage));
664 /// \brief Attribute reading rule
666 /// Add an attribute reading rule with specialized converter to the
668 template <typename Value, typename Converter>
669 DigraphReader& attribute(const std::string& caption, Value& value,
670 const Converter& converter = Converter()) {
671 _reader_bits::ValueStorageBase* storage =
672 new _reader_bits::ValueStorage<Value, Converter>(value, converter);
673 _attributes.insert(std::make_pair(caption, storage));
677 /// \brief Node reading rule
679 /// Add a node reading rule to reader.
680 DigraphReader& node(const std::string& caption, Node& node) {
681 typedef _reader_bits::MapLookUpConverter<Node> Converter;
682 Converter converter(_node_index);
683 _reader_bits::ValueStorageBase* storage =
684 new _reader_bits::ValueStorage<Node, Converter>(node, converter);
685 _attributes.insert(std::make_pair(caption, storage));
689 /// \brief Arc reading rule
691 /// Add an arc reading rule to reader.
692 DigraphReader& arc(const std::string& caption, Arc& arc) {
693 typedef _reader_bits::MapLookUpConverter<Arc> Converter;
694 Converter converter(_arc_index);
695 _reader_bits::ValueStorageBase* storage =
696 new _reader_bits::ValueStorage<Arc, Converter>(arc, converter);
697 _attributes.insert(std::make_pair(caption, storage));
703 /// \name Select section by name
706 /// \brief Set \c \@nodes section to be read
708 /// Set \c \@nodes section to be read
709 DigraphReader& nodes(const std::string& caption) {
710 _nodes_caption = caption;
714 /// \brief Set \c \@arcs section to be read
716 /// Set \c \@arcs section to be read
717 DigraphReader& arcs(const std::string& caption) {
718 _arcs_caption = caption;
722 /// \brief Set \c \@attributes section to be read
724 /// Set \c \@attributes section to be read
725 DigraphReader& attributes(const std::string& caption) {
726 _attributes_caption = caption;
732 /// \name Using previously constructed node or arc set
735 /// \brief Use previously constructed node set
737 /// Use previously constructed node set, and specify the node
739 template <typename Map>
740 DigraphReader& useNodes(const Map& map) {
741 checkConcept<concepts::ReadMap<Node, typename Map::Value>, Map>();
742 LEMON_ASSERT(!_use_nodes, "Multiple usage of useNodes() member");
744 _writer_bits::DefaultConverter<typename Map::Value> converter;
745 for (NodeIt n(_digraph); n != INVALID; ++n) {
746 _node_index.insert(std::make_pair(converter(map[n]), n));
751 /// \brief Use previously constructed node set
753 /// Use previously constructed node set, and specify the node
754 /// label map and a functor which converts the label map values to
756 template <typename Map, typename Converter>
757 DigraphReader& useNodes(const Map& map,
758 const Converter& converter = Converter()) {
759 checkConcept<concepts::ReadMap<Node, typename Map::Value>, Map>();
760 LEMON_ASSERT(!_use_nodes, "Multiple usage of useNodes() member");
762 for (NodeIt n(_digraph); n != INVALID; ++n) {
763 _node_index.insert(std::make_pair(converter(map[n]), n));
768 /// \brief Use previously constructed arc set
770 /// Use previously constructed arc set, and specify the arc
772 template <typename Map>
773 DigraphReader& useArcs(const Map& map) {
774 checkConcept<concepts::ReadMap<Arc, typename Map::Value>, Map>();
775 LEMON_ASSERT(!_use_arcs, "Multiple usage of useArcs() member");
777 _writer_bits::DefaultConverter<typename Map::Value> converter;
778 for (ArcIt a(_digraph); a != INVALID; ++a) {
779 _arc_index.insert(std::make_pair(converter(map[a]), a));
784 /// \brief Use previously constructed arc set
786 /// Use previously constructed arc set, and specify the arc
787 /// label map and a functor which converts the label map values to
789 template <typename Map, typename Converter>
790 DigraphReader& useArcs(const Map& map,
791 const Converter& converter = Converter()) {
792 checkConcept<concepts::ReadMap<Arc, typename Map::Value>, Map>();
793 LEMON_ASSERT(!_use_arcs, "Multiple usage of useArcs() member");
795 for (ArcIt a(_digraph); a != INVALID; ++a) {
796 _arc_index.insert(std::make_pair(converter(map[a]), a));
801 /// \brief Skips the reading of node section
803 /// Omit the reading of the node section. This implies that each node
804 /// map reading rule will be abandoned, and the nodes of the graph
805 /// will not be constructed, which usually cause that the arc set
806 /// could not be read due to lack of node name resolving.
807 /// Therefore \c skipArcs() function should also be used, or
808 /// \c useNodes() should be used to specify the label of the nodes.
809 DigraphReader& skipNodes() {
810 LEMON_ASSERT(!_skip_nodes, "Skip nodes already set");
815 /// \brief Skips the reading of arc section
817 /// Omit the reading of the arc section. This implies that each arc
818 /// map reading rule will be abandoned, and the arcs of the graph
819 /// will not be constructed.
820 DigraphReader& skipArcs() {
821 LEMON_ASSERT(!_skip_arcs, "Skip arcs already set");
832 while(++line_num, std::getline(*_is, str)) {
833 line.clear(); line.str(str);
835 if (line >> std::ws >> c && c != '#') {
844 return static_cast<bool>(*_is);
849 while (readSuccess() && line >> c && c != '@') {
857 std::vector<int> map_index(_node_maps.size());
858 int map_num, label_index;
861 if (!readLine() || !(line >> c) || c == '@') {
862 if (readSuccess() && line) line.putback(c);
863 if (!_node_maps.empty())
864 throw FormatError("Cannot find map names");
870 std::map<std::string, int> maps;
874 while (_reader_bits::readToken(line, map)) {
875 if (maps.find(map) != maps.end()) {
876 std::ostringstream msg;
877 msg << "Multiple occurence of node map: " << map;
878 throw FormatError(msg.str());
880 maps.insert(std::make_pair(map, index));
884 for (int i = 0; i < static_cast<int>(_node_maps.size()); ++i) {
885 std::map<std::string, int>::iterator jt =
886 maps.find(_node_maps[i].first);
887 if (jt == maps.end()) {
888 std::ostringstream msg;
889 msg << "Map not found: " << _node_maps[i].first;
890 throw FormatError(msg.str());
892 map_index[i] = jt->second;
896 std::map<std::string, int>::iterator jt = maps.find("label");
897 if (jt != maps.end()) {
898 label_index = jt->second;
903 map_num = maps.size();
906 while (readLine() && line >> c && c != '@') {
909 std::vector<std::string> tokens(map_num);
910 for (int i = 0; i < map_num; ++i) {
911 if (!_reader_bits::readToken(line, tokens[i])) {
912 std::ostringstream msg;
913 msg << "Column not found (" << i + 1 << ")";
914 throw FormatError(msg.str());
917 if (line >> std::ws >> c)
918 throw FormatError("Extra character at the end of line");
922 n = _digraph.addNode();
923 if (label_index != -1)
924 _node_index.insert(std::make_pair(tokens[label_index], n));
926 if (label_index == -1)
927 throw FormatError("Label map not found");
928 typename std::map<std::string, Node>::iterator it =
929 _node_index.find(tokens[label_index]);
930 if (it == _node_index.end()) {
931 std::ostringstream msg;
932 msg << "Node with label not found: " << tokens[label_index];
933 throw FormatError(msg.str());
938 for (int i = 0; i < static_cast<int>(_node_maps.size()); ++i) {
939 _node_maps[i].second->set(n, tokens[map_index[i]]);
950 std::vector<int> map_index(_arc_maps.size());
951 int map_num, label_index;
954 if (!readLine() || !(line >> c) || c == '@') {
955 if (readSuccess() && line) line.putback(c);
956 if (!_arc_maps.empty())
957 throw FormatError("Cannot find map names");
963 std::map<std::string, int> maps;
967 while (_reader_bits::readToken(line, map)) {
968 if (maps.find(map) != maps.end()) {
969 std::ostringstream msg;
970 msg << "Multiple occurence of arc map: " << map;
971 throw FormatError(msg.str());
973 maps.insert(std::make_pair(map, index));
977 for (int i = 0; i < static_cast<int>(_arc_maps.size()); ++i) {
978 std::map<std::string, int>::iterator jt =
979 maps.find(_arc_maps[i].first);
980 if (jt == maps.end()) {
981 std::ostringstream msg;
982 msg << "Map not found: " << _arc_maps[i].first;
983 throw FormatError(msg.str());
985 map_index[i] = jt->second;
989 std::map<std::string, int>::iterator jt = maps.find("label");
990 if (jt != maps.end()) {
991 label_index = jt->second;
996 map_num = maps.size();
999 while (readLine() && line >> c && c != '@') {
1002 std::string source_token;
1003 std::string target_token;
1005 if (!_reader_bits::readToken(line, source_token))
1006 throw FormatError("Source not found");
1008 if (!_reader_bits::readToken(line, target_token))
1009 throw FormatError("Target not found");
1011 std::vector<std::string> tokens(map_num);
1012 for (int i = 0; i < map_num; ++i) {
1013 if (!_reader_bits::readToken(line, tokens[i])) {
1014 std::ostringstream msg;
1015 msg << "Column not found (" << i + 1 << ")";
1016 throw FormatError(msg.str());
1019 if (line >> std::ws >> c)
1020 throw FormatError("Extra character at the end of line");
1025 typename NodeIndex::iterator it;
1027 it = _node_index.find(source_token);
1028 if (it == _node_index.end()) {
1029 std::ostringstream msg;
1030 msg << "Item not found: " << source_token;
1031 throw FormatError(msg.str());
1033 Node source = it->second;
1035 it = _node_index.find(target_token);
1036 if (it == _node_index.end()) {
1037 std::ostringstream msg;
1038 msg << "Item not found: " << target_token;
1039 throw FormatError(msg.str());
1041 Node target = it->second;
1043 a = _digraph.addArc(source, target);
1044 if (label_index != -1)
1045 _arc_index.insert(std::make_pair(tokens[label_index], a));
1047 if (label_index == -1)
1048 throw FormatError("Label map not found");
1049 typename std::map<std::string, Arc>::iterator it =
1050 _arc_index.find(tokens[label_index]);
1051 if (it == _arc_index.end()) {
1052 std::ostringstream msg;
1053 msg << "Arc with label not found: " << tokens[label_index];
1054 throw FormatError(msg.str());
1059 for (int i = 0; i < static_cast<int>(_arc_maps.size()); ++i) {
1060 _arc_maps[i].second->set(a, tokens[map_index[i]]);
1064 if (readSuccess()) {
1069 void readAttributes() {
1071 std::set<std::string> read_attr;
1074 while (readLine() && line >> c && c != '@') {
1077 std::string attr, token;
1078 if (!_reader_bits::readToken(line, attr))
1079 throw FormatError("Attribute name not found");
1080 if (!_reader_bits::readToken(line, token))
1081 throw FormatError("Attribute value not found");
1083 throw FormatError("Extra character at the end of line");
1086 std::set<std::string>::iterator it = read_attr.find(attr);
1087 if (it != read_attr.end()) {
1088 std::ostringstream msg;
1089 msg << "Multiple occurence of attribute: " << attr;
1090 throw FormatError(msg.str());
1092 read_attr.insert(attr);
1096 typename Attributes::iterator it = _attributes.lower_bound(attr);
1097 while (it != _attributes.end() && it->first == attr) {
1098 it->second->set(token);
1104 if (readSuccess()) {
1107 for (typename Attributes::iterator it = _attributes.begin();
1108 it != _attributes.end(); ++it) {
1109 if (read_attr.find(it->first) == read_attr.end()) {
1110 std::ostringstream msg;
1111 msg << "Attribute not found: " << it->first;
1112 throw FormatError(msg.str());
1119 /// \name Execution of the reader
1122 /// \brief Start the batch processing
1124 /// This function starts the batch processing
1126 LEMON_ASSERT(_is != 0, "This reader assigned to an other reader");
1128 bool nodes_done = _skip_nodes;
1129 bool arcs_done = _skip_arcs;
1130 bool attributes_done = false;
1136 while (readSuccess()) {
1139 std::string section, caption;
1141 _reader_bits::readToken(line, section);
1142 _reader_bits::readToken(line, caption);
1145 throw FormatError("Extra character at the end of line");
1147 if (section == "nodes" && !nodes_done) {
1148 if (_nodes_caption.empty() || _nodes_caption == caption) {
1152 } else if ((section == "arcs" || section == "edges") &&
1154 if (_arcs_caption.empty() || _arcs_caption == caption) {
1158 } else if (section == "attributes" && !attributes_done) {
1159 if (_attributes_caption.empty() || _attributes_caption == caption) {
1161 attributes_done = true;
1167 } catch (FormatError& error) {
1168 error.line(line_num);
1169 error.file(_filename);
1175 throw FormatError("Section @nodes not found");
1179 throw FormatError("Section @arcs not found");
1182 if (!attributes_done && !_attributes.empty()) {
1183 throw FormatError("Section @attributes not found");
1192 /// \brief Return a \ref DigraphReader class
1194 /// This function just returns a \ref DigraphReader class.
1195 /// \relates DigraphReader
1196 template <typename Digraph>
1197 DigraphReader<Digraph> digraphReader(Digraph& digraph,
1198 std::istream& is = std::cin) {
1199 DigraphReader<Digraph> tmp(digraph, is);
1203 /// \brief Return a \ref DigraphReader class
1205 /// This function just returns a \ref DigraphReader class.
1206 /// \relates DigraphReader
1207 template <typename Digraph>
1208 DigraphReader<Digraph> digraphReader(Digraph& digraph,
1209 const std::string& fn) {
1210 DigraphReader<Digraph> tmp(digraph, fn);
1214 /// \brief Return a \ref DigraphReader class
1216 /// This function just returns a \ref DigraphReader class.
1217 /// \relates DigraphReader
1218 template <typename Digraph>
1219 DigraphReader<Digraph> digraphReader(Digraph& digraph, const char* fn) {
1220 DigraphReader<Digraph> tmp(digraph, fn);
1224 template <typename Graph>
1227 template <typename Graph>
1228 GraphReader<Graph> graphReader(Graph& graph,
1229 std::istream& is = std::cin);
1231 template <typename Graph>
1232 GraphReader<Graph> graphReader(Graph& graph, const std::string& fn);
1234 template <typename Graph>
1235 GraphReader<Graph> graphReader(Graph& graph, const char *fn);
1237 /// \ingroup lemon_io
1239 /// \brief \ref lgf-format "LGF" reader for undirected graphs
1241 /// This utility reads an \ref lgf-format "LGF" file.
1243 /// It can be used almost the same way as \c DigraphReader.
1244 /// The only difference is that this class can handle edges and
1245 /// edge maps as well as arcs and arc maps.
1247 /// The columns in the \c \@edges (or \c \@arcs) section are the
1248 /// edge maps. However, if there are two maps with the same name
1249 /// prefixed with \c '+' and \c '-', then these can be read into an
1250 /// arc map. Similarly, an attribute can be read into an arc, if
1251 /// it's value is an edge label prefixed with \c '+' or \c '-'.
1252 template <typename _Graph>
1256 typedef _Graph Graph;
1257 TEMPLATE_GRAPH_TYPEDEFS(Graph);
1263 std::string _filename;
1267 std::string _nodes_caption;
1268 std::string _edges_caption;
1269 std::string _attributes_caption;
1271 typedef std::map<std::string, Node> NodeIndex;
1272 NodeIndex _node_index;
1273 typedef std::map<std::string, Edge> EdgeIndex;
1274 EdgeIndex _edge_index;
1276 typedef std::vector<std::pair<std::string,
1277 _reader_bits::MapStorageBase<Node>*> > NodeMaps;
1278 NodeMaps _node_maps;
1280 typedef std::vector<std::pair<std::string,
1281 _reader_bits::MapStorageBase<Edge>*> > EdgeMaps;
1282 EdgeMaps _edge_maps;
1284 typedef std::multimap<std::string, _reader_bits::ValueStorageBase*>
1286 Attributes _attributes;
1295 std::istringstream line;
1299 /// \brief Constructor
1301 /// Construct an undirected graph reader, which reads from the given
1303 GraphReader(Graph& graph, std::istream& is = std::cin)
1304 : _is(&is), local_is(false), _graph(graph),
1305 _use_nodes(false), _use_edges(false),
1306 _skip_nodes(false), _skip_edges(false) {}
1308 /// \brief Constructor
1310 /// Construct an undirected graph reader, which reads from the given
1312 GraphReader(Graph& graph, const std::string& fn)
1313 : _is(new std::ifstream(fn.c_str())), local_is(true),
1314 _filename(fn), _graph(graph),
1315 _use_nodes(false), _use_edges(false),
1316 _skip_nodes(false), _skip_edges(false) {
1319 throw IoError("Cannot open file", fn);
1323 /// \brief Constructor
1325 /// Construct an undirected graph reader, which reads from the given
1327 GraphReader(Graph& graph, const char* fn)
1328 : _is(new std::ifstream(fn)), local_is(true),
1329 _filename(fn), _graph(graph),
1330 _use_nodes(false), _use_edges(false),
1331 _skip_nodes(false), _skip_edges(false) {
1334 throw IoError("Cannot open file", fn);
1338 /// \brief Destructor
1340 for (typename NodeMaps::iterator it = _node_maps.begin();
1341 it != _node_maps.end(); ++it) {
1345 for (typename EdgeMaps::iterator it = _edge_maps.begin();
1346 it != _edge_maps.end(); ++it) {
1350 for (typename Attributes::iterator it = _attributes.begin();
1351 it != _attributes.end(); ++it) {
1362 friend GraphReader<Graph> graphReader<>(Graph& graph, std::istream& is);
1363 friend GraphReader<Graph> graphReader<>(Graph& graph,
1364 const std::string& fn);
1365 friend GraphReader<Graph> graphReader<>(Graph& graph, const char *fn);
1367 GraphReader(GraphReader& other)
1368 : _is(other._is), local_is(other.local_is), _graph(other._graph),
1369 _use_nodes(other._use_nodes), _use_edges(other._use_edges),
1370 _skip_nodes(other._skip_nodes), _skip_edges(other._skip_edges) {
1373 other.local_is = false;
1375 _node_index.swap(other._node_index);
1376 _edge_index.swap(other._edge_index);
1378 _node_maps.swap(other._node_maps);
1379 _edge_maps.swap(other._edge_maps);
1380 _attributes.swap(other._attributes);
1382 _nodes_caption = other._nodes_caption;
1383 _edges_caption = other._edges_caption;
1384 _attributes_caption = other._attributes_caption;
1388 GraphReader& operator=(const GraphReader&);
1392 /// \name Reading rules
1395 /// \brief Node map reading rule
1397 /// Add a node map reading rule to the reader.
1398 template <typename Map>
1399 GraphReader& nodeMap(const std::string& caption, Map& map) {
1400 checkConcept<concepts::WriteMap<Node, typename Map::Value>, Map>();
1401 _reader_bits::MapStorageBase<Node>* storage =
1402 new _reader_bits::MapStorage<Node, Map>(map);
1403 _node_maps.push_back(std::make_pair(caption, storage));
1407 /// \brief Node map reading rule
1409 /// Add a node map reading rule with specialized converter to the
1411 template <typename Map, typename Converter>
1412 GraphReader& nodeMap(const std::string& caption, Map& map,
1413 const Converter& converter = Converter()) {
1414 checkConcept<concepts::WriteMap<Node, typename Map::Value>, Map>();
1415 _reader_bits::MapStorageBase<Node>* storage =
1416 new _reader_bits::MapStorage<Node, Map, Converter>(map, converter);
1417 _node_maps.push_back(std::make_pair(caption, storage));
1421 /// \brief Edge map reading rule
1423 /// Add an edge map reading rule to the reader.
1424 template <typename Map>
1425 GraphReader& edgeMap(const std::string& caption, Map& map) {
1426 checkConcept<concepts::WriteMap<Edge, typename Map::Value>, Map>();
1427 _reader_bits::MapStorageBase<Edge>* storage =
1428 new _reader_bits::MapStorage<Edge, Map>(map);
1429 _edge_maps.push_back(std::make_pair(caption, storage));
1433 /// \brief Edge map reading rule
1435 /// Add an edge map reading rule with specialized converter to the
1437 template <typename Map, typename Converter>
1438 GraphReader& edgeMap(const std::string& caption, Map& map,
1439 const Converter& converter = Converter()) {
1440 checkConcept<concepts::WriteMap<Edge, typename Map::Value>, Map>();
1441 _reader_bits::MapStorageBase<Edge>* storage =
1442 new _reader_bits::MapStorage<Edge, Map, Converter>(map, converter);
1443 _edge_maps.push_back(std::make_pair(caption, storage));
1447 /// \brief Arc map reading rule
1449 /// Add an arc map reading rule to the reader.
1450 template <typename Map>
1451 GraphReader& arcMap(const std::string& caption, Map& map) {
1452 checkConcept<concepts::WriteMap<Arc, typename Map::Value>, Map>();
1453 _reader_bits::MapStorageBase<Edge>* forward_storage =
1454 new _reader_bits::GraphArcMapStorage<Graph, true, Map>(_graph, map);
1455 _edge_maps.push_back(std::make_pair('+' + caption, forward_storage));
1456 _reader_bits::MapStorageBase<Edge>* backward_storage =
1457 new _reader_bits::GraphArcMapStorage<Graph, false, Map>(_graph, map);
1458 _edge_maps.push_back(std::make_pair('-' + caption, backward_storage));
1462 /// \brief Arc map reading rule
1464 /// Add an arc map reading rule with specialized converter to the
1466 template <typename Map, typename Converter>
1467 GraphReader& arcMap(const std::string& caption, Map& map,
1468 const Converter& converter = Converter()) {
1469 checkConcept<concepts::WriteMap<Arc, typename Map::Value>, Map>();
1470 _reader_bits::MapStorageBase<Edge>* forward_storage =
1471 new _reader_bits::GraphArcMapStorage<Graph, true, Map, Converter>
1472 (_graph, map, converter);
1473 _edge_maps.push_back(std::make_pair('+' + caption, forward_storage));
1474 _reader_bits::MapStorageBase<Edge>* backward_storage =
1475 new _reader_bits::GraphArcMapStorage<Graph, false, Map, Converter>
1476 (_graph, map, converter);
1477 _edge_maps.push_back(std::make_pair('-' + caption, backward_storage));
1481 /// \brief Attribute reading rule
1483 /// Add an attribute reading rule to the reader.
1484 template <typename Value>
1485 GraphReader& attribute(const std::string& caption, Value& value) {
1486 _reader_bits::ValueStorageBase* storage =
1487 new _reader_bits::ValueStorage<Value>(value);
1488 _attributes.insert(std::make_pair(caption, storage));
1492 /// \brief Attribute reading rule
1494 /// Add an attribute reading rule with specialized converter to the
1496 template <typename Value, typename Converter>
1497 GraphReader& attribute(const std::string& caption, Value& value,
1498 const Converter& converter = Converter()) {
1499 _reader_bits::ValueStorageBase* storage =
1500 new _reader_bits::ValueStorage<Value, Converter>(value, converter);
1501 _attributes.insert(std::make_pair(caption, storage));
1505 /// \brief Node reading rule
1507 /// Add a node reading rule to reader.
1508 GraphReader& node(const std::string& caption, Node& node) {
1509 typedef _reader_bits::MapLookUpConverter<Node> Converter;
1510 Converter converter(_node_index);
1511 _reader_bits::ValueStorageBase* storage =
1512 new _reader_bits::ValueStorage<Node, Converter>(node, converter);
1513 _attributes.insert(std::make_pair(caption, storage));
1517 /// \brief Edge reading rule
1519 /// Add an edge reading rule to reader.
1520 GraphReader& edge(const std::string& caption, Edge& edge) {
1521 typedef _reader_bits::MapLookUpConverter<Edge> Converter;
1522 Converter converter(_edge_index);
1523 _reader_bits::ValueStorageBase* storage =
1524 new _reader_bits::ValueStorage<Edge, Converter>(edge, converter);
1525 _attributes.insert(std::make_pair(caption, storage));
1529 /// \brief Arc reading rule
1531 /// Add an arc reading rule to reader.
1532 GraphReader& arc(const std::string& caption, Arc& arc) {
1533 typedef _reader_bits::GraphArcLookUpConverter<Graph> Converter;
1534 Converter converter(_graph, _edge_index);
1535 _reader_bits::ValueStorageBase* storage =
1536 new _reader_bits::ValueStorage<Arc, Converter>(arc, converter);
1537 _attributes.insert(std::make_pair(caption, storage));
1543 /// \name Select section by name
1546 /// \brief Set \c \@nodes section to be read
1548 /// Set \c \@nodes section to be read.
1549 GraphReader& nodes(const std::string& caption) {
1550 _nodes_caption = caption;
1554 /// \brief Set \c \@edges section to be read
1556 /// Set \c \@edges section to be read.
1557 GraphReader& edges(const std::string& caption) {
1558 _edges_caption = caption;
1562 /// \brief Set \c \@attributes section to be read
1564 /// Set \c \@attributes section to be read.
1565 GraphReader& attributes(const std::string& caption) {
1566 _attributes_caption = caption;
1572 /// \name Using previously constructed node or edge set
1575 /// \brief Use previously constructed node set
1577 /// Use previously constructed node set, and specify the node
1579 template <typename Map>
1580 GraphReader& useNodes(const Map& map) {
1581 checkConcept<concepts::ReadMap<Node, typename Map::Value>, Map>();
1582 LEMON_ASSERT(!_use_nodes, "Multiple usage of useNodes() member");
1584 _writer_bits::DefaultConverter<typename Map::Value> converter;
1585 for (NodeIt n(_graph); n != INVALID; ++n) {
1586 _node_index.insert(std::make_pair(converter(map[n]), n));
1591 /// \brief Use previously constructed node set
1593 /// Use previously constructed node set, and specify the node
1594 /// label map and a functor which converts the label map values to
1596 template <typename Map, typename Converter>
1597 GraphReader& useNodes(const Map& map,
1598 const Converter& converter = Converter()) {
1599 checkConcept<concepts::ReadMap<Node, typename Map::Value>, Map>();
1600 LEMON_ASSERT(!_use_nodes, "Multiple usage of useNodes() member");
1602 for (NodeIt n(_graph); n != INVALID; ++n) {
1603 _node_index.insert(std::make_pair(converter(map[n]), n));
1608 /// \brief Use previously constructed edge set
1610 /// Use previously constructed edge set, and specify the edge
1612 template <typename Map>
1613 GraphReader& useEdges(const Map& map) {
1614 checkConcept<concepts::ReadMap<Edge, typename Map::Value>, Map>();
1615 LEMON_ASSERT(!_use_edges, "Multiple usage of useEdges() member");
1617 _writer_bits::DefaultConverter<typename Map::Value> converter;
1618 for (EdgeIt a(_graph); a != INVALID; ++a) {
1619 _edge_index.insert(std::make_pair(converter(map[a]), a));
1624 /// \brief Use previously constructed edge set
1626 /// Use previously constructed edge set, and specify the edge
1627 /// label map and a functor which converts the label map values to
1629 template <typename Map, typename Converter>
1630 GraphReader& useEdges(const Map& map,
1631 const Converter& converter = Converter()) {
1632 checkConcept<concepts::ReadMap<Edge, typename Map::Value>, Map>();
1633 LEMON_ASSERT(!_use_edges, "Multiple usage of useEdges() member");
1635 for (EdgeIt a(_graph); a != INVALID; ++a) {
1636 _edge_index.insert(std::make_pair(converter(map[a]), a));
1641 /// \brief Skip the reading of node section
1643 /// Omit the reading of the node section. This implies that each node
1644 /// map reading rule will be abandoned, and the nodes of the graph
1645 /// will not be constructed, which usually cause that the edge set
1646 /// could not be read due to lack of node name
1647 /// could not be read due to lack of node name resolving.
1648 /// Therefore \c skipEdges() function should also be used, or
1649 /// \c useNodes() should be used to specify the label of the nodes.
1650 GraphReader& skipNodes() {
1651 LEMON_ASSERT(!_skip_nodes, "Skip nodes already set");
1656 /// \brief Skip the reading of edge section
1658 /// Omit the reading of the edge section. This implies that each edge
1659 /// map reading rule will be abandoned, and the edges of the graph
1660 /// will not be constructed.
1661 GraphReader& skipEdges() {
1662 LEMON_ASSERT(!_skip_edges, "Skip edges already set");
1673 while(++line_num, std::getline(*_is, str)) {
1674 line.clear(); line.str(str);
1676 if (line >> std::ws >> c && c != '#') {
1684 bool readSuccess() {
1685 return static_cast<bool>(*_is);
1688 void skipSection() {
1690 while (readSuccess() && line >> c && c != '@') {
1698 std::vector<int> map_index(_node_maps.size());
1699 int map_num, label_index;
1702 if (!readLine() || !(line >> c) || c == '@') {
1703 if (readSuccess() && line) line.putback(c);
1704 if (!_node_maps.empty())
1705 throw FormatError("Cannot find map names");
1711 std::map<std::string, int> maps;
1715 while (_reader_bits::readToken(line, map)) {
1716 if (maps.find(map) != maps.end()) {
1717 std::ostringstream msg;
1718 msg << "Multiple occurence of node map: " << map;
1719 throw FormatError(msg.str());
1721 maps.insert(std::make_pair(map, index));
1725 for (int i = 0; i < static_cast<int>(_node_maps.size()); ++i) {
1726 std::map<std::string, int>::iterator jt =
1727 maps.find(_node_maps[i].first);
1728 if (jt == maps.end()) {
1729 std::ostringstream msg;
1730 msg << "Map not found: " << _node_maps[i].first;
1731 throw FormatError(msg.str());
1733 map_index[i] = jt->second;
1737 std::map<std::string, int>::iterator jt = maps.find("label");
1738 if (jt != maps.end()) {
1739 label_index = jt->second;
1744 map_num = maps.size();
1747 while (readLine() && line >> c && c != '@') {
1750 std::vector<std::string> tokens(map_num);
1751 for (int i = 0; i < map_num; ++i) {
1752 if (!_reader_bits::readToken(line, tokens[i])) {
1753 std::ostringstream msg;
1754 msg << "Column not found (" << i + 1 << ")";
1755 throw FormatError(msg.str());
1758 if (line >> std::ws >> c)
1759 throw FormatError("Extra character at the end of line");
1763 n = _graph.addNode();
1764 if (label_index != -1)
1765 _node_index.insert(std::make_pair(tokens[label_index], n));
1767 if (label_index == -1)
1768 throw FormatError("Label map not found");
1769 typename std::map<std::string, Node>::iterator it =
1770 _node_index.find(tokens[label_index]);
1771 if (it == _node_index.end()) {
1772 std::ostringstream msg;
1773 msg << "Node with label not found: " << tokens[label_index];
1774 throw FormatError(msg.str());
1779 for (int i = 0; i < static_cast<int>(_node_maps.size()); ++i) {
1780 _node_maps[i].second->set(n, tokens[map_index[i]]);
1784 if (readSuccess()) {
1791 std::vector<int> map_index(_edge_maps.size());
1792 int map_num, label_index;
1795 if (!readLine() || !(line >> c) || c == '@') {
1796 if (readSuccess() && line) line.putback(c);
1797 if (!_edge_maps.empty())
1798 throw FormatError("Cannot find map names");
1804 std::map<std::string, int> maps;
1808 while (_reader_bits::readToken(line, map)) {
1809 if (maps.find(map) != maps.end()) {
1810 std::ostringstream msg;
1811 msg << "Multiple occurence of edge map: " << map;
1812 throw FormatError(msg.str());
1814 maps.insert(std::make_pair(map, index));
1818 for (int i = 0; i < static_cast<int>(_edge_maps.size()); ++i) {
1819 std::map<std::string, int>::iterator jt =
1820 maps.find(_edge_maps[i].first);
1821 if (jt == maps.end()) {
1822 std::ostringstream msg;
1823 msg << "Map not found: " << _edge_maps[i].first;
1824 throw FormatError(msg.str());
1826 map_index[i] = jt->second;
1830 std::map<std::string, int>::iterator jt = maps.find("label");
1831 if (jt != maps.end()) {
1832 label_index = jt->second;
1837 map_num = maps.size();
1840 while (readLine() && line >> c && c != '@') {
1843 std::string source_token;
1844 std::string target_token;
1846 if (!_reader_bits::readToken(line, source_token))
1847 throw FormatError("Node u not found");
1849 if (!_reader_bits::readToken(line, target_token))
1850 throw FormatError("Node v not found");
1852 std::vector<std::string> tokens(map_num);
1853 for (int i = 0; i < map_num; ++i) {
1854 if (!_reader_bits::readToken(line, tokens[i])) {
1855 std::ostringstream msg;
1856 msg << "Column not found (" << i + 1 << ")";
1857 throw FormatError(msg.str());
1860 if (line >> std::ws >> c)
1861 throw FormatError("Extra character at the end of line");
1866 typename NodeIndex::iterator it;
1868 it = _node_index.find(source_token);
1869 if (it == _node_index.end()) {
1870 std::ostringstream msg;
1871 msg << "Item not found: " << source_token;
1872 throw FormatError(msg.str());
1874 Node source = it->second;
1876 it = _node_index.find(target_token);
1877 if (it == _node_index.end()) {
1878 std::ostringstream msg;
1879 msg << "Item not found: " << target_token;
1880 throw FormatError(msg.str());
1882 Node target = it->second;
1884 e = _graph.addEdge(source, target);
1885 if (label_index != -1)
1886 _edge_index.insert(std::make_pair(tokens[label_index], e));
1888 if (label_index == -1)
1889 throw FormatError("Label map not found");
1890 typename std::map<std::string, Edge>::iterator it =
1891 _edge_index.find(tokens[label_index]);
1892 if (it == _edge_index.end()) {
1893 std::ostringstream msg;
1894 msg << "Edge with label not found: " << tokens[label_index];
1895 throw FormatError(msg.str());
1900 for (int i = 0; i < static_cast<int>(_edge_maps.size()); ++i) {
1901 _edge_maps[i].second->set(e, tokens[map_index[i]]);
1905 if (readSuccess()) {
1910 void readAttributes() {
1912 std::set<std::string> read_attr;
1915 while (readLine() && line >> c && c != '@') {
1918 std::string attr, token;
1919 if (!_reader_bits::readToken(line, attr))
1920 throw FormatError("Attribute name not found");
1921 if (!_reader_bits::readToken(line, token))
1922 throw FormatError("Attribute value not found");
1924 throw FormatError("Extra character at the end of line");
1927 std::set<std::string>::iterator it = read_attr.find(attr);
1928 if (it != read_attr.end()) {
1929 std::ostringstream msg;
1930 msg << "Multiple occurence of attribute: " << attr;
1931 throw FormatError(msg.str());
1933 read_attr.insert(attr);
1937 typename Attributes::iterator it = _attributes.lower_bound(attr);
1938 while (it != _attributes.end() && it->first == attr) {
1939 it->second->set(token);
1945 if (readSuccess()) {
1948 for (typename Attributes::iterator it = _attributes.begin();
1949 it != _attributes.end(); ++it) {
1950 if (read_attr.find(it->first) == read_attr.end()) {
1951 std::ostringstream msg;
1952 msg << "Attribute not found: " << it->first;
1953 throw FormatError(msg.str());
1960 /// \name Execution of the reader
1963 /// \brief Start the batch processing
1965 /// This function starts the batch processing
1968 LEMON_ASSERT(_is != 0, "This reader assigned to an other reader");
1970 bool nodes_done = _skip_nodes;
1971 bool edges_done = _skip_edges;
1972 bool attributes_done = false;
1978 while (readSuccess()) {
1981 std::string section, caption;
1983 _reader_bits::readToken(line, section);
1984 _reader_bits::readToken(line, caption);
1987 throw FormatError("Extra character at the end of line");
1989 if (section == "nodes" && !nodes_done) {
1990 if (_nodes_caption.empty() || _nodes_caption == caption) {
1994 } else if ((section == "edges" || section == "arcs") &&
1996 if (_edges_caption.empty() || _edges_caption == caption) {
2000 } else if (section == "attributes" && !attributes_done) {
2001 if (_attributes_caption.empty() || _attributes_caption == caption) {
2003 attributes_done = true;
2009 } catch (FormatError& error) {
2010 error.line(line_num);
2011 error.file(_filename);
2017 throw FormatError("Section @nodes not found");
2021 throw FormatError("Section @edges not found");
2024 if (!attributes_done && !_attributes.empty()) {
2025 throw FormatError("Section @attributes not found");
2034 /// \brief Return a \ref GraphReader class
2036 /// This function just returns a \ref GraphReader class.
2037 /// \relates GraphReader
2038 template <typename Graph>
2039 GraphReader<Graph> graphReader(Graph& graph, std::istream& is = std::cin) {
2040 GraphReader<Graph> tmp(graph, is);
2044 /// \brief Return a \ref GraphReader class
2046 /// This function just returns a \ref GraphReader class.
2047 /// \relates GraphReader
2048 template <typename Graph>
2049 GraphReader<Graph> graphReader(Graph& graph, const std::string& fn) {
2050 GraphReader<Graph> tmp(graph, fn);
2054 /// \brief Return a \ref GraphReader class
2056 /// This function just returns a \ref GraphReader class.
2057 /// \relates GraphReader
2058 template <typename Graph>
2059 GraphReader<Graph> graphReader(Graph& graph, const char* fn) {
2060 GraphReader<Graph> tmp(graph, fn);
2064 class SectionReader;
2066 SectionReader sectionReader(std::istream& is);
2067 SectionReader sectionReader(const std::string& fn);
2068 SectionReader sectionReader(const char* fn);
2070 /// \ingroup lemon_io
2072 /// \brief Section reader class
2074 /// In the \ref lgf-format "LGF" file extra sections can be placed,
2075 /// which contain any data in arbitrary format. Such sections can be
2076 /// read with this class. A reading rule can be added to the class
2077 /// with two different functions. With the \c sectionLines() function a
2078 /// functor can process the section line-by-line, while with the \c
2079 /// sectionStream() member the section can be read from an input
2081 class SectionReader {
2086 std::string _filename;
2088 typedef std::map<std::string, _reader_bits::Section*> Sections;
2092 std::istringstream line;
2096 /// \brief Constructor
2098 /// Construct a section reader, which reads from the given input
2100 SectionReader(std::istream& is)
2101 : _is(&is), local_is(false) {}
2103 /// \brief Constructor
2105 /// Construct a section reader, which reads from the given file.
2106 SectionReader(const std::string& fn)
2107 : _is(new std::ifstream(fn.c_str())), local_is(true),
2111 throw IoError("Cannot open file", fn);
2115 /// \brief Constructor
2117 /// Construct a section reader, which reads from the given file.
2118 SectionReader(const char* fn)
2119 : _is(new std::ifstream(fn)), local_is(true),
2123 throw IoError("Cannot open file", fn);
2127 /// \brief Destructor
2129 for (Sections::iterator it = _sections.begin();
2130 it != _sections.end(); ++it) {
2142 friend SectionReader sectionReader(std::istream& is);
2143 friend SectionReader sectionReader(const std::string& fn);
2144 friend SectionReader sectionReader(const char* fn);
2146 SectionReader(SectionReader& other)
2147 : _is(other._is), local_is(other.local_is) {
2150 other.local_is = false;
2152 _sections.swap(other._sections);
2155 SectionReader& operator=(const SectionReader&);
2159 /// \name Section readers
2162 /// \brief Add a section processor with line oriented reading
2164 /// The first parameter is the type descriptor of the section, the
2165 /// second is a functor, which takes just one \c std::string
2166 /// parameter. At the reading process, each line of the section
2167 /// will be given to the functor object. However, the empty lines
2168 /// and the comment lines are filtered out, and the leading
2169 /// whitespaces are trimmed from each processed string.
2171 /// For example let's see a section, which contain several
2172 /// integers, which should be inserted into a vector.
2180 /// The functor is implemented as a struct:
2182 /// struct NumberSection {
2183 /// std::vector<int>& _data;
2184 /// NumberSection(std::vector<int>& data) : _data(data) {}
2185 /// void operator()(const std::string& line) {
2186 /// std::istringstream ls(line);
2188 /// while (ls >> value) _data.push_back(value);
2194 /// reader.sectionLines("numbers", NumberSection(vec));
2196 template <typename Functor>
2197 SectionReader& sectionLines(const std::string& type, Functor functor) {
2198 LEMON_ASSERT(!type.empty(), "Type is empty.");
2199 LEMON_ASSERT(_sections.find(type) == _sections.end(),
2200 "Multiple reading of section.");
2201 _sections.insert(std::make_pair(type,
2202 new _reader_bits::LineSection<Functor>(functor)));
2207 /// \brief Add a section processor with stream oriented reading
2209 /// The first parameter is the type of the section, the second is
2210 /// a functor, which takes an \c std::istream& and an \c int&
2211 /// parameter, the latter regard to the line number of stream. The
2212 /// functor can read the input while the section go on, and the
2213 /// line number should be modified accordingly.
2214 template <typename Functor>
2215 SectionReader& sectionStream(const std::string& type, Functor functor) {
2216 LEMON_ASSERT(!type.empty(), "Type is empty.");
2217 LEMON_ASSERT(_sections.find(type) == _sections.end(),
2218 "Multiple reading of section.");
2219 _sections.insert(std::make_pair(type,
2220 new _reader_bits::StreamSection<Functor>(functor)));
2230 while(++line_num, std::getline(*_is, str)) {
2231 line.clear(); line.str(str);
2233 if (line >> std::ws >> c && c != '#') {
2241 bool readSuccess() {
2242 return static_cast<bool>(*_is);
2245 void skipSection() {
2247 while (readSuccess() && line >> c && c != '@') {
2256 /// \name Execution of the reader
2259 /// \brief Start the batch processing
2261 /// This function starts the batch processing.
2264 LEMON_ASSERT(_is != 0, "This reader assigned to an other reader");
2266 std::set<std::string> extra_sections;
2272 while (readSuccess()) {
2275 std::string section, caption;
2277 _reader_bits::readToken(line, section);
2278 _reader_bits::readToken(line, caption);
2281 throw FormatError("Extra character at the end of line");
2283 if (extra_sections.find(section) != extra_sections.end()) {
2284 std::ostringstream msg;
2285 msg << "Multiple occurence of section: " << section;
2286 throw FormatError(msg.str());
2288 Sections::iterator it = _sections.find(section);
2289 if (it != _sections.end()) {
2290 extra_sections.insert(section);
2291 it->second->process(*_is, line_num);
2295 } catch (FormatError& error) {
2296 error.line(line_num);
2297 error.file(_filename);
2301 for (Sections::iterator it = _sections.begin();
2302 it != _sections.end(); ++it) {
2303 if (extra_sections.find(it->first) == extra_sections.end()) {
2304 std::ostringstream os;
2305 os << "Cannot find section: " << it->first;
2306 throw FormatError(os.str());
2315 /// \brief Return a \ref SectionReader class
2317 /// This function just returns a \ref SectionReader class.
2318 /// \relates SectionReader
2319 inline SectionReader sectionReader(std::istream& is) {
2320 SectionReader tmp(is);
2324 /// \brief Return a \ref SectionReader class
2326 /// This function just returns a \ref SectionReader class.
2327 /// \relates SectionReader
2328 inline SectionReader sectionReader(const std::string& fn) {
2329 SectionReader tmp(fn);
2333 /// \brief Return a \ref SectionReader class
2335 /// This function just returns a \ref SectionReader class.
2336 /// \relates SectionReader
2337 inline SectionReader sectionReader(const char* fn) {
2338 SectionReader tmp(fn);
2342 /// \ingroup lemon_io
2344 /// \brief Reader for the contents of the \ref lgf-format "LGF" file
2346 /// This class can be used to read the sections, the map names and
2347 /// the attributes from a file. Usually, the LEMON programs know
2348 /// that, which type of graph, which maps and which attributes
2349 /// should be read from a file, but in general tools (like glemon)
2350 /// the contents of an LGF file should be guessed somehow. This class
2351 /// reads the graph and stores the appropriate information for
2352 /// reading the graph.
2355 /// LgfContents contents("graph.lgf");
2358 /// // Does it contain any node section and arc section?
2359 /// if (contents.nodeSectionNum() == 0 || contents.arcSectionNum()) {
2360 /// std::cerr << "Failure, cannot find graph." << std::endl;
2363 /// std::cout << "The name of the default node section: "
2364 /// << contents.nodeSection(0) << std::endl;
2365 /// std::cout << "The number of the arc maps: "
2366 /// << contents.arcMaps(0).size() << std::endl;
2367 /// std::cout << "The name of second arc map: "
2368 /// << contents.arcMaps(0)[1] << std::endl;
2376 std::vector<std::string> _node_sections;
2377 std::vector<std::string> _edge_sections;
2378 std::vector<std::string> _attribute_sections;
2379 std::vector<std::string> _extra_sections;
2381 std::vector<bool> _arc_sections;
2383 std::vector<std::vector<std::string> > _node_maps;
2384 std::vector<std::vector<std::string> > _edge_maps;
2386 std::vector<std::vector<std::string> > _attributes;
2390 std::istringstream line;
2394 /// \brief Constructor
2396 /// Construct an \e LGF contents reader, which reads from the given
2398 LgfContents(std::istream& is)
2399 : _is(&is), local_is(false) {}
2401 /// \brief Constructor
2403 /// Construct an \e LGF contents reader, which reads from the given
2405 LgfContents(const std::string& fn)
2406 : _is(new std::ifstream(fn.c_str())), local_is(true) {
2409 throw IoError("Cannot open file", fn);
2413 /// \brief Constructor
2415 /// Construct an \e LGF contents reader, which reads from the given
2417 LgfContents(const char* fn)
2418 : _is(new std::ifstream(fn)), local_is(true) {
2421 throw IoError("Cannot open file", fn);
2425 /// \brief Destructor
2427 if (local_is) delete _is;
2432 LgfContents(const LgfContents&);
2433 LgfContents& operator=(const LgfContents&);
2438 /// \name Node sections
2441 /// \brief Gives back the number of node sections in the file.
2443 /// Gives back the number of node sections in the file.
2444 int nodeSectionNum() const {
2445 return _node_sections.size();
2448 /// \brief Returns the node section name at the given position.
2450 /// Returns the node section name at the given position.
2451 const std::string& nodeSection(int i) const {
2452 return _node_sections[i];
2455 /// \brief Gives back the node maps for the given section.
2457 /// Gives back the node maps for the given section.
2458 const std::vector<std::string>& nodeMapNames(int i) const {
2459 return _node_maps[i];
2464 /// \name Arc/Edge sections
2467 /// \brief Gives back the number of arc/edge sections in the file.
2469 /// Gives back the number of arc/edge sections in the file.
2470 /// \note It is synonym of \c edgeSectionNum().
2471 int arcSectionNum() const {
2472 return _edge_sections.size();
2475 /// \brief Returns the arc/edge section name at the given position.
2477 /// Returns the arc/edge section name at the given position.
2478 /// \note It is synonym of \c edgeSection().
2479 const std::string& arcSection(int i) const {
2480 return _edge_sections[i];
2483 /// \brief Gives back the arc/edge maps for the given section.
2485 /// Gives back the arc/edge maps for the given section.
2486 /// \note It is synonym of \c edgeMapNames().
2487 const std::vector<std::string>& arcMapNames(int i) const {
2488 return _edge_maps[i];
2496 /// \brief Gives back the number of arc/edge sections in the file.
2498 /// Gives back the number of arc/edge sections in the file.
2499 /// \note It is synonym of \c arcSectionNum().
2500 int edgeSectionNum() const {
2501 return _edge_sections.size();
2504 /// \brief Returns the section name at the given position.
2506 /// Returns the section name at the given position.
2507 /// \note It is synonym of \c arcSection().
2508 const std::string& edgeSection(int i) const {
2509 return _edge_sections[i];
2512 /// \brief Gives back the edge maps for the given section.
2514 /// Gives back the edge maps for the given section.
2515 /// \note It is synonym of \c arcMapNames().
2516 const std::vector<std::string>& edgeMapNames(int i) const {
2517 return _edge_maps[i];
2522 /// \name Attribute sections
2525 /// \brief Gives back the number of attribute sections in the file.
2527 /// Gives back the number of attribute sections in the file.
2528 int attributeSectionNum() const {
2529 return _attribute_sections.size();
2532 /// \brief Returns the attribute section name at the given position.
2534 /// Returns the attribute section name at the given position.
2535 const std::string& attributeSectionNames(int i) const {
2536 return _attribute_sections[i];
2539 /// \brief Gives back the attributes for the given section.
2541 /// Gives back the attributes for the given section.
2542 const std::vector<std::string>& attributes(int i) const {
2543 return _attributes[i];
2548 /// \name Extra sections
2551 /// \brief Gives back the number of extra sections in the file.
2553 /// Gives back the number of extra sections in the file.
2554 int extraSectionNum() const {
2555 return _extra_sections.size();
2558 /// \brief Returns the extra section type at the given position.
2560 /// Returns the section type at the given position.
2561 const std::string& extraSection(int i) const {
2562 return _extra_sections[i];
2571 while(++line_num, std::getline(*_is, str)) {
2572 line.clear(); line.str(str);
2574 if (line >> std::ws >> c && c != '#') {
2582 bool readSuccess() {
2583 return static_cast<bool>(*_is);
2586 void skipSection() {
2588 while (readSuccess() && line >> c && c != '@') {
2594 void readMaps(std::vector<std::string>& maps) {
2596 if (!readLine() || !(line >> c) || c == '@') {
2597 if (readSuccess() && line) line.putback(c);
2602 while (_reader_bits::readToken(line, map)) {
2603 maps.push_back(map);
2607 void readAttributes(std::vector<std::string>& attrs) {
2610 while (readSuccess() && line >> c && c != '@') {
2613 _reader_bits::readToken(line, attr);
2614 attrs.push_back(attr);
2622 /// \name Execution of the contents reader
2625 /// \brief Starts the reading
2627 /// This function starts the reading.
2633 while (readSuccess()) {
2638 std::string section, caption;
2639 _reader_bits::readToken(line, section);
2640 _reader_bits::readToken(line, caption);
2642 if (section == "nodes") {
2643 _node_sections.push_back(caption);
2644 _node_maps.push_back(std::vector<std::string>());
2645 readMaps(_node_maps.back());
2646 readLine(); skipSection();
2647 } else if (section == "arcs" || section == "edges") {
2648 _edge_sections.push_back(caption);
2649 _arc_sections.push_back(section == "arcs");
2650 _edge_maps.push_back(std::vector<std::string>());
2651 readMaps(_edge_maps.back());
2652 readLine(); skipSection();
2653 } else if (section == "attributes") {
2654 _attribute_sections.push_back(caption);
2655 _attributes.push_back(std::vector<std::string>());
2656 readAttributes(_attributes.back());
2658 _extra_sections.push_back(section);
2659 readLine(); skipSection();