lemon/lgf_reader.h
author Balazs Dezso <deba@inf.elte.hu>
Tue, 30 Sep 2008 20:53:18 +0200
changeset 290 f6899946c1ac
parent 236 da953e387d31
child 291 d901321d6555
permissions -rw-r--r--
Simplifying exceptions

- Using asserts instead of exceptions for unitialized parameters
- Only the IO exceptions are used in the lemon
- DataFormatError is renamed to FormatError
- The IoError is used for file access errors
alpar@209
     1
/* -*- mode: C++; indent-tabs-mode: nil; -*-
deba@127
     2
 *
alpar@209
     3
 * This file is a part of LEMON, a generic C++ optimization library.
deba@127
     4
 *
deba@127
     5
 * Copyright (C) 2003-2008
deba@127
     6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
deba@127
     7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
deba@127
     8
 *
deba@127
     9
 * Permission to use, modify and distribute this software is granted
deba@127
    10
 * provided that this copyright notice appears in all copies. For
deba@127
    11
 * precise terms see the accompanying LICENSE file.
deba@127
    12
 *
deba@127
    13
 * This software is provided "AS IS" with no warranty of any kind,
deba@127
    14
 * express or implied, and with no claim as to its suitability for any
deba@127
    15
 * purpose.
deba@127
    16
 *
deba@127
    17
 */
deba@127
    18
deba@127
    19
///\ingroup lemon_io
deba@127
    20
///\file
ladanyi@236
    21
///\brief \ref lgf-format "LEMON Graph Format" reader.
deba@127
    22
deba@127
    23
deba@127
    24
#ifndef LEMON_LGF_READER_H
deba@127
    25
#define LEMON_LGF_READER_H
deba@127
    26
deba@127
    27
#include <iostream>
deba@127
    28
#include <fstream>
deba@127
    29
#include <sstream>
deba@127
    30
deba@127
    31
#include <set>
deba@127
    32
#include <map>
deba@127
    33
deba@127
    34
#include <lemon/assert.h>
deba@220
    35
#include <lemon/core.h>
deba@127
    36
deba@127
    37
#include <lemon/lgf_writer.h>
deba@127
    38
deba@127
    39
#include <lemon/concept_check.h>
deba@127
    40
#include <lemon/concepts/maps.h>
deba@127
    41
deba@127
    42
namespace lemon {
deba@127
    43
deba@127
    44
  namespace _reader_bits {
deba@127
    45
deba@127
    46
    template <typename Value>
deba@127
    47
    struct DefaultConverter {
deba@127
    48
      Value operator()(const std::string& str) {
alpar@209
    49
        std::istringstream is(str);
alpar@209
    50
        Value value;
deba@290
    51
        if (!(is >> value)) {
deba@290
    52
          throw FormatError("Cannot read token");
deba@290
    53
        }
alpar@209
    54
alpar@209
    55
        char c;
alpar@209
    56
        if (is >> std::ws >> c) {
deba@290
    57
          throw FormatError("Remaining characters in token");
alpar@209
    58
        }
alpar@209
    59
        return value;
deba@127
    60
      }
deba@127
    61
    };
deba@127
    62
deba@127
    63
    template <>
deba@127
    64
    struct DefaultConverter<std::string> {
deba@127
    65
      std::string operator()(const std::string& str) {
alpar@209
    66
        return str;
deba@127
    67
      }
deba@127
    68
    };
deba@127
    69
alpar@209
    70
    template <typename _Item>
deba@127
    71
    class MapStorageBase {
deba@127
    72
    public:
deba@127
    73
      typedef _Item Item;
deba@127
    74
deba@127
    75
    public:
deba@127
    76
      MapStorageBase() {}
deba@127
    77
      virtual ~MapStorageBase() {}
deba@127
    78
deba@127
    79
      virtual void set(const Item& item, const std::string& value) = 0;
deba@127
    80
deba@127
    81
    };
deba@127
    82
alpar@209
    83
    template <typename _Item, typename _Map,
alpar@209
    84
              typename _Converter = DefaultConverter<typename _Map::Value> >
deba@127
    85
    class MapStorage : public MapStorageBase<_Item> {
deba@127
    86
    public:
deba@127
    87
      typedef _Map Map;
deba@127
    88
      typedef _Converter Converter;
deba@127
    89
      typedef _Item Item;
alpar@209
    90
deba@127
    91
    private:
deba@127
    92
      Map& _map;
deba@127
    93
      Converter _converter;
deba@127
    94
deba@127
    95
    public:
alpar@209
    96
      MapStorage(Map& map, const Converter& converter = Converter())
alpar@209
    97
        : _map(map), _converter(converter) {}
deba@127
    98
      virtual ~MapStorage() {}
deba@127
    99
deba@127
   100
      virtual void set(const Item& item ,const std::string& value) {
alpar@209
   101
        _map.set(item, _converter(value));
deba@127
   102
      }
deba@127
   103
    };
deba@127
   104
alpar@209
   105
    template <typename _Graph, bool _dir, typename _Map,
alpar@209
   106
              typename _Converter = DefaultConverter<typename _Map::Value> >
deba@165
   107
    class GraphArcMapStorage : public MapStorageBase<typename _Graph::Edge> {
deba@165
   108
    public:
deba@165
   109
      typedef _Map Map;
deba@165
   110
      typedef _Converter Converter;
deba@165
   111
      typedef _Graph Graph;
deba@165
   112
      typedef typename Graph::Edge Item;
deba@165
   113
      static const bool dir = _dir;
alpar@209
   114
deba@165
   115
    private:
deba@165
   116
      const Graph& _graph;
deba@165
   117
      Map& _map;
deba@165
   118
      Converter _converter;
deba@165
   119
deba@165
   120
    public:
alpar@209
   121
      GraphArcMapStorage(const Graph& graph, Map& map,
alpar@209
   122
                         const Converter& converter = Converter())
alpar@209
   123
        : _graph(graph), _map(map), _converter(converter) {}
deba@165
   124
      virtual ~GraphArcMapStorage() {}
deba@165
   125
deba@165
   126
      virtual void set(const Item& item ,const std::string& value) {
alpar@209
   127
        _map.set(_graph.direct(item, dir), _converter(value));
deba@165
   128
      }
deba@165
   129
    };
deba@165
   130
deba@127
   131
    class ValueStorageBase {
deba@127
   132
    public:
deba@127
   133
      ValueStorageBase() {}
deba@127
   134
      virtual ~ValueStorageBase() {}
deba@127
   135
deba@127
   136
      virtual void set(const std::string&) = 0;
deba@127
   137
    };
deba@127
   138
deba@127
   139
    template <typename _Value, typename _Converter = DefaultConverter<_Value> >
deba@127
   140
    class ValueStorage : public ValueStorageBase {
deba@127
   141
    public:
deba@127
   142
      typedef _Value Value;
deba@127
   143
      typedef _Converter Converter;
deba@127
   144
deba@127
   145
    private:
deba@127
   146
      Value& _value;
deba@127
   147
      Converter _converter;
deba@127
   148
deba@127
   149
    public:
deba@127
   150
      ValueStorage(Value& value, const Converter& converter = Converter())
kpeter@212
   151
        : _value(value), _converter(converter) {}
deba@127
   152
deba@127
   153
      virtual void set(const std::string& value) {
alpar@209
   154
        _value = _converter(value);
deba@127
   155
      }
deba@127
   156
    };
deba@127
   157
deba@127
   158
    template <typename Value>
deba@127
   159
    struct MapLookUpConverter {
deba@127
   160
      const std::map<std::string, Value>& _map;
deba@127
   161
deba@127
   162
      MapLookUpConverter(const std::map<std::string, Value>& map)
deba@127
   163
        : _map(map) {}
deba@127
   164
deba@127
   165
      Value operator()(const std::string& str) {
deba@127
   166
        typename std::map<std::string, Value>::const_iterator it =
deba@127
   167
          _map.find(str);
deba@127
   168
        if (it == _map.end()) {
deba@127
   169
          std::ostringstream msg;
deba@127
   170
          msg << "Item not found: " << str;
deba@290
   171
          throw FormatError(msg.str());
deba@127
   172
        }
deba@127
   173
        return it->second;
deba@127
   174
      }
deba@127
   175
    };
deba@127
   176
deba@165
   177
    template <typename Graph>
deba@165
   178
    struct GraphArcLookUpConverter {
deba@165
   179
      const Graph& _graph;
deba@165
   180
      const std::map<std::string, typename Graph::Edge>& _map;
alpar@209
   181
alpar@209
   182
      GraphArcLookUpConverter(const Graph& graph,
alpar@209
   183
                              const std::map<std::string,
alpar@209
   184
                                             typename Graph::Edge>& map)
alpar@209
   185
        : _graph(graph), _map(map) {}
alpar@209
   186
deba@165
   187
      typename Graph::Arc operator()(const std::string& str) {
alpar@209
   188
        if (str.empty() || (str[0] != '+' && str[0] != '-')) {
deba@290
   189
          throw FormatError("Item must start with '+' or '-'");
alpar@209
   190
        }
alpar@209
   191
        typename std::map<std::string, typename Graph::Edge>
alpar@209
   192
          ::const_iterator it = _map.find(str.substr(1));
alpar@209
   193
        if (it == _map.end()) {
deba@290
   194
          throw FormatError("Item not found");
alpar@209
   195
        }
alpar@209
   196
        return _graph.direct(it->second, str[0] == '+');
deba@165
   197
      }
deba@165
   198
    };
deba@165
   199
deba@197
   200
    inline bool isWhiteSpace(char c) {
alpar@209
   201
      return c == ' ' || c == '\t' || c == '\v' ||
alpar@209
   202
        c == '\n' || c == '\r' || c == '\f';
deba@127
   203
    }
alpar@209
   204
deba@197
   205
    inline bool isOct(char c) {
alpar@209
   206
      return '0' <= c && c <='7';
deba@127
   207
    }
alpar@209
   208
deba@197
   209
    inline int valueOct(char c) {
deba@127
   210
      LEMON_ASSERT(isOct(c), "The character is not octal.");
deba@127
   211
      return c - '0';
deba@127
   212
    }
deba@127
   213
deba@197
   214
    inline bool isHex(char c) {
alpar@209
   215
      return ('0' <= c && c <= '9') ||
alpar@209
   216
        ('a' <= c && c <= 'z') ||
alpar@209
   217
        ('A' <= c && c <= 'Z');
deba@127
   218
    }
alpar@209
   219
deba@197
   220
    inline int valueHex(char c) {
deba@127
   221
      LEMON_ASSERT(isHex(c), "The character is not hexadecimal.");
deba@127
   222
      if ('0' <= c && c <= '9') return c - '0';
deba@127
   223
      if ('a' <= c && c <= 'z') return c - 'a' + 10;
deba@127
   224
      return c - 'A' + 10;
deba@127
   225
    }
deba@127
   226
deba@197
   227
    inline bool isIdentifierFirstChar(char c) {
deba@127
   228
      return ('a' <= c && c <= 'z') ||
alpar@209
   229
        ('A' <= c && c <= 'Z') || c == '_';
deba@127
   230
    }
deba@127
   231
deba@197
   232
    inline bool isIdentifierChar(char c) {
deba@127
   233
      return isIdentifierFirstChar(c) ||
alpar@209
   234
        ('0' <= c && c <= '9');
deba@127
   235
    }
deba@127
   236
deba@197
   237
    inline char readEscape(std::istream& is) {
deba@127
   238
      char c;
deba@127
   239
      if (!is.get(c))
deba@290
   240
        throw FormatError("Escape format error");
deba@127
   241
deba@127
   242
      switch (c) {
deba@127
   243
      case '\\':
alpar@209
   244
        return '\\';
deba@127
   245
      case '\"':
alpar@209
   246
        return '\"';
deba@127
   247
      case '\'':
alpar@209
   248
        return '\'';
deba@127
   249
      case '\?':
alpar@209
   250
        return '\?';
deba@127
   251
      case 'a':
alpar@209
   252
        return '\a';
deba@127
   253
      case 'b':
alpar@209
   254
        return '\b';
deba@127
   255
      case 'f':
alpar@209
   256
        return '\f';
deba@127
   257
      case 'n':
alpar@209
   258
        return '\n';
deba@127
   259
      case 'r':
alpar@209
   260
        return '\r';
deba@127
   261
      case 't':
alpar@209
   262
        return '\t';
deba@127
   263
      case 'v':
alpar@209
   264
        return '\v';
deba@127
   265
      case 'x':
alpar@209
   266
        {
alpar@209
   267
          int code;
alpar@209
   268
          if (!is.get(c) || !isHex(c))
deba@290
   269
            throw FormatError("Escape format error");
alpar@209
   270
          else if (code = valueHex(c), !is.get(c) || !isHex(c)) is.putback(c);
alpar@209
   271
          else code = code * 16 + valueHex(c);
alpar@209
   272
          return code;
alpar@209
   273
        }
deba@127
   274
      default:
alpar@209
   275
        {
alpar@209
   276
          int code;
alpar@209
   277
          if (!isOct(c))
deba@290
   278
            throw FormatError("Escape format error");
alpar@209
   279
          else if (code = valueOct(c), !is.get(c) || !isOct(c))
alpar@209
   280
            is.putback(c);
alpar@209
   281
          else if (code = code * 8 + valueOct(c), !is.get(c) || !isOct(c))
alpar@209
   282
            is.putback(c);
alpar@209
   283
          else code = code * 8 + valueOct(c);
alpar@209
   284
          return code;
alpar@209
   285
        }
alpar@209
   286
      }
deba@127
   287
    }
alpar@209
   288
deba@197
   289
    inline std::istream& readToken(std::istream& is, std::string& str) {
deba@127
   290
      std::ostringstream os;
deba@127
   291
deba@127
   292
      char c;
deba@127
   293
      is >> std::ws;
alpar@209
   294
alpar@209
   295
      if (!is.get(c))
alpar@209
   296
        return is;
deba@127
   297
deba@127
   298
      if (c == '\"') {
alpar@209
   299
        while (is.get(c) && c != '\"') {
alpar@209
   300
          if (c == '\\')
alpar@209
   301
            c = readEscape(is);
alpar@209
   302
          os << c;
alpar@209
   303
        }
alpar@209
   304
        if (!is)
deba@290
   305
          throw FormatError("Quoted format error");
deba@127
   306
      } else {
alpar@209
   307
        is.putback(c);
alpar@209
   308
        while (is.get(c) && !isWhiteSpace(c)) {
alpar@209
   309
          if (c == '\\')
alpar@209
   310
            c = readEscape(is);
alpar@209
   311
          os << c;
alpar@209
   312
        }
alpar@209
   313
        if (!is) {
alpar@209
   314
          is.clear();
alpar@209
   315
        } else {
alpar@209
   316
          is.putback(c);
alpar@209
   317
        }
deba@127
   318
      }
deba@127
   319
      str = os.str();
deba@127
   320
      return is;
deba@127
   321
    }
deba@162
   322
deba@162
   323
    class Section {
deba@162
   324
    public:
deba@162
   325
      virtual ~Section() {}
deba@162
   326
      virtual void process(std::istream& is, int& line_num) = 0;
deba@162
   327
    };
deba@162
   328
deba@162
   329
    template <typename Functor>
deba@162
   330
    class LineSection : public Section {
deba@162
   331
    private:
deba@162
   332
deba@162
   333
      Functor _functor;
deba@162
   334
deba@162
   335
    public:
alpar@209
   336
deba@162
   337
      LineSection(const Functor& functor) : _functor(functor) {}
deba@162
   338
      virtual ~LineSection() {}
deba@162
   339
deba@162
   340
      virtual void process(std::istream& is, int& line_num) {
alpar@209
   341
        char c;
alpar@209
   342
        std::string line;
alpar@209
   343
        while (is.get(c) && c != '@') {
alpar@209
   344
          if (c == '\n') {
alpar@209
   345
            ++line_num;
alpar@209
   346
          } else if (c == '#') {
alpar@209
   347
            getline(is, line);
alpar@209
   348
            ++line_num;
alpar@209
   349
          } else if (!isWhiteSpace(c)) {
alpar@209
   350
            is.putback(c);
alpar@209
   351
            getline(is, line);
alpar@209
   352
            _functor(line);
alpar@209
   353
            ++line_num;
alpar@209
   354
          }
alpar@209
   355
        }
alpar@209
   356
        if (is) is.putback(c);
alpar@209
   357
        else if (is.eof()) is.clear();
deba@162
   358
      }
deba@162
   359
    };
deba@162
   360
deba@162
   361
    template <typename Functor>
deba@162
   362
    class StreamSection : public Section {
deba@162
   363
    private:
deba@162
   364
deba@162
   365
      Functor _functor;
deba@162
   366
deba@162
   367
    public:
alpar@209
   368
deba@162
   369
      StreamSection(const Functor& functor) : _functor(functor) {}
alpar@209
   370
      virtual ~StreamSection() {}
deba@162
   371
deba@162
   372
      virtual void process(std::istream& is, int& line_num) {
alpar@209
   373
        _functor(is, line_num);
alpar@209
   374
        char c;
alpar@209
   375
        std::string line;
alpar@209
   376
        while (is.get(c) && c != '@') {
alpar@209
   377
          if (c == '\n') {
alpar@209
   378
            ++line_num;
alpar@209
   379
          } else if (!isWhiteSpace(c)) {
alpar@209
   380
            getline(is, line);
alpar@209
   381
            ++line_num;
alpar@209
   382
          }
alpar@209
   383
        }
alpar@209
   384
        if (is) is.putback(c);
alpar@209
   385
        else if (is.eof()) is.clear();
deba@162
   386
      }
deba@162
   387
    };
alpar@209
   388
deba@127
   389
  }
alpar@156
   390
deba@190
   391
  template <typename Digraph>
deba@190
   392
  class DigraphReader;
deba@190
   393
deba@190
   394
  template <typename Digraph>
deba@190
   395
  DigraphReader<Digraph> digraphReader(std::istream& is, Digraph& digraph);
deba@190
   396
deba@190
   397
  template <typename Digraph>
deba@190
   398
  DigraphReader<Digraph> digraphReader(const std::string& fn, Digraph& digraph);
deba@190
   399
deba@190
   400
  template <typename Digraph>
deba@190
   401
  DigraphReader<Digraph> digraphReader(const char *fn, Digraph& digraph);
deba@190
   402
alpar@156
   403
  /// \ingroup lemon_io
alpar@209
   404
  ///
kpeter@192
   405
  /// \brief \ref lgf-format "LGF" reader for directed graphs
alpar@156
   406
  ///
alpar@156
   407
  /// This utility reads an \ref lgf-format "LGF" file.
alpar@156
   408
  ///
alpar@156
   409
  /// The reading method does a batch processing. The user creates a
alpar@156
   410
  /// reader object, then various reading rules can be added to the
alpar@156
   411
  /// reader, and eventually the reading is executed with the \c run()
alpar@156
   412
  /// member function. A map reading rule can be added to the reader
alpar@156
   413
  /// with the \c nodeMap() or \c arcMap() members. An optional
deba@162
   414
  /// converter parameter can also be added as a standard functor
kpeter@192
   415
  /// converting from \c std::string to the value type of the map. If it
deba@162
   416
  /// is set, it will determine how the tokens in the file should be
kpeter@192
   417
  /// converted to the value type of the map. If the functor is not set,
deba@162
   418
  /// then a default conversion will be used. One map can be read into
deba@162
   419
  /// multiple map objects at the same time. The \c attribute(), \c
deba@162
   420
  /// node() and \c arc() functions are used to add attribute reading
deba@162
   421
  /// rules.
alpar@156
   422
  ///
alpar@156
   423
  ///\code
kpeter@192
   424
  /// DigraphReader<Digraph>(std::cin, digraph).
kpeter@192
   425
  ///   nodeMap("coordinates", coord_map).
kpeter@192
   426
  ///   arcMap("capacity", cap_map).
kpeter@192
   427
  ///   node("source", src).
kpeter@192
   428
  ///   node("target", trg).
kpeter@192
   429
  ///   attribute("caption", caption).
kpeter@192
   430
  ///   run();
alpar@156
   431
  ///\endcode
alpar@156
   432
  ///
alpar@156
   433
  /// By default the reader uses the first section in the file of the
alpar@156
   434
  /// proper type. If a section has an optional name, then it can be
deba@162
   435
  /// selected for reading by giving an optional name parameter to the
deba@189
   436
  /// \c nodes(), \c arcs() or \c attributes() functions.
alpar@156
   437
  ///
alpar@156
   438
  /// The \c useNodes() and \c useArcs() functions are used to tell the reader
alpar@156
   439
  /// that the nodes or arcs should not be constructed (added to the
alpar@156
   440
  /// graph) during the reading, but instead the label map of the items
alpar@156
   441
  /// are given as a parameter of these functions. An
kpeter@192
   442
  /// application of these functions is multipass reading, which is
kpeter@192
   443
  /// important if two \c \@arcs sections must be read from the
kpeter@192
   444
  /// file. In this case the first phase would read the node set and one
alpar@156
   445
  /// of the arc sets, while the second phase would read the second arc
alpar@156
   446
  /// set into an \e ArcSet class (\c SmartArcSet or \c ListArcSet).
alpar@156
   447
  /// The previously read label node map should be passed to the \c
alpar@156
   448
  /// useNodes() functions. Another application of multipass reading when
alpar@210
   449
  /// paths are given as a node map or an arc map.
alpar@210
   450
  /// It is impossible to read this in
alpar@156
   451
  /// a single pass, because the arcs are not constructed when the node
alpar@156
   452
  /// maps are read.
deba@127
   453
  template <typename _Digraph>
deba@127
   454
  class DigraphReader {
deba@127
   455
  public:
deba@127
   456
deba@127
   457
    typedef _Digraph Digraph;
deba@148
   458
    TEMPLATE_DIGRAPH_TYPEDEFS(Digraph);
alpar@209
   459
deba@127
   460
  private:
deba@127
   461
deba@127
   462
deba@127
   463
    std::istream* _is;
deba@127
   464
    bool local_is;
deba@290
   465
    std::string _filename;
deba@127
   466
deba@127
   467
    Digraph& _digraph;
deba@127
   468
deba@127
   469
    std::string _nodes_caption;
deba@127
   470
    std::string _arcs_caption;
deba@127
   471
    std::string _attributes_caption;
deba@127
   472
deba@127
   473
    typedef std::map<std::string, Node> NodeIndex;
deba@127
   474
    NodeIndex _node_index;
deba@127
   475
    typedef std::map<std::string, Arc> ArcIndex;
deba@127
   476
    ArcIndex _arc_index;
alpar@209
   477
alpar@209
   478
    typedef std::vector<std::pair<std::string,
alpar@209
   479
      _reader_bits::MapStorageBase<Node>*> > NodeMaps;
alpar@209
   480
    NodeMaps _node_maps;
deba@127
   481
deba@127
   482
    typedef std::vector<std::pair<std::string,
deba@127
   483
      _reader_bits::MapStorageBase<Arc>*> >ArcMaps;
deba@127
   484
    ArcMaps _arc_maps;
deba@127
   485
alpar@209
   486
    typedef std::multimap<std::string, _reader_bits::ValueStorageBase*>
deba@127
   487
      Attributes;
deba@127
   488
    Attributes _attributes;
deba@127
   489
deba@127
   490
    bool _use_nodes;
deba@127
   491
    bool _use_arcs;
deba@127
   492
deba@188
   493
    bool _skip_nodes;
deba@188
   494
    bool _skip_arcs;
deba@188
   495
deba@127
   496
    int line_num;
deba@127
   497
    std::istringstream line;
deba@127
   498
deba@127
   499
  public:
deba@127
   500
alpar@156
   501
    /// \brief Constructor
alpar@156
   502
    ///
alpar@156
   503
    /// Construct a directed graph reader, which reads from the given
alpar@156
   504
    /// input stream.
alpar@209
   505
    DigraphReader(std::istream& is, Digraph& digraph)
deba@127
   506
      : _is(&is), local_is(false), _digraph(digraph),
alpar@209
   507
        _use_nodes(false), _use_arcs(false),
alpar@209
   508
        _skip_nodes(false), _skip_arcs(false) {}
deba@127
   509
alpar@156
   510
    /// \brief Constructor
alpar@156
   511
    ///
alpar@156
   512
    /// Construct a directed graph reader, which reads from the given
alpar@156
   513
    /// file.
alpar@209
   514
    DigraphReader(const std::string& fn, Digraph& digraph)
deba@290
   515
      : _is(new std::ifstream(fn.c_str())), local_is(true),
deba@290
   516
        _filename(fn), _digraph(digraph),
kpeter@212
   517
        _use_nodes(false), _use_arcs(false),
deba@290
   518
        _skip_nodes(false), _skip_arcs(false) {
deba@290
   519
      if (!(*_is)) throw IoError(fn, "Cannot open file");
deba@290
   520
    }
alpar@209
   521
alpar@156
   522
    /// \brief Constructor
alpar@156
   523
    ///
alpar@156
   524
    /// Construct a directed graph reader, which reads from the given
alpar@156
   525
    /// file.
alpar@209
   526
    DigraphReader(const char* fn, Digraph& digraph)
deba@290
   527
      : _is(new std::ifstream(fn)), local_is(true),
deba@290
   528
        _filename(fn), _digraph(digraph),
kpeter@212
   529
        _use_nodes(false), _use_arcs(false),
deba@290
   530
        _skip_nodes(false), _skip_arcs(false) {
deba@290
   531
      if (!(*_is)) throw IoError(fn, "Cannot open file");
deba@290
   532
    }
deba@127
   533
alpar@156
   534
    /// \brief Destructor
deba@127
   535
    ~DigraphReader() {
alpar@209
   536
      for (typename NodeMaps::iterator it = _node_maps.begin();
alpar@209
   537
           it != _node_maps.end(); ++it) {
alpar@209
   538
        delete it->second;
deba@127
   539
      }
deba@127
   540
alpar@209
   541
      for (typename ArcMaps::iterator it = _arc_maps.begin();
alpar@209
   542
           it != _arc_maps.end(); ++it) {
alpar@209
   543
        delete it->second;
deba@127
   544
      }
deba@127
   545
alpar@209
   546
      for (typename Attributes::iterator it = _attributes.begin();
alpar@209
   547
           it != _attributes.end(); ++it) {
alpar@209
   548
        delete it->second;
deba@127
   549
      }
deba@127
   550
deba@127
   551
      if (local_is) {
alpar@209
   552
        delete _is;
deba@127
   553
      }
deba@127
   554
deba@127
   555
    }
deba@127
   556
deba@127
   557
  private:
deba@190
   558
alpar@209
   559
    friend DigraphReader<Digraph> digraphReader<>(std::istream& is,
alpar@209
   560
                                                  Digraph& digraph);
alpar@209
   561
    friend DigraphReader<Digraph> digraphReader<>(const std::string& fn,
alpar@209
   562
                                                  Digraph& digraph);
alpar@209
   563
    friend DigraphReader<Digraph> digraphReader<>(const char *fn,
alpar@209
   564
                                                  Digraph& digraph);
alpar@209
   565
alpar@209
   566
    DigraphReader(DigraphReader& other)
deba@190
   567
      : _is(other._is), local_is(other.local_is), _digraph(other._digraph),
alpar@209
   568
        _use_nodes(other._use_nodes), _use_arcs(other._use_arcs),
alpar@209
   569
        _skip_nodes(other._skip_nodes), _skip_arcs(other._skip_arcs) {
deba@190
   570
deba@190
   571
      other._is = 0;
deba@190
   572
      other.local_is = false;
alpar@209
   573
deba@190
   574
      _node_index.swap(other._node_index);
deba@190
   575
      _arc_index.swap(other._arc_index);
deba@190
   576
deba@190
   577
      _node_maps.swap(other._node_maps);
deba@190
   578
      _arc_maps.swap(other._arc_maps);
deba@190
   579
      _attributes.swap(other._attributes);
deba@190
   580
deba@190
   581
      _nodes_caption = other._nodes_caption;
deba@190
   582
      _arcs_caption = other._arcs_caption;
deba@190
   583
      _attributes_caption = other._attributes_caption;
deba@190
   584
deba@190
   585
    }
deba@190
   586
deba@127
   587
    DigraphReader& operator=(const DigraphReader&);
deba@127
   588
deba@127
   589
  public:
deba@127
   590
alpar@156
   591
    /// \name Reading rules
alpar@156
   592
    /// @{
alpar@209
   593
alpar@156
   594
    /// \brief Node map reading rule
alpar@156
   595
    ///
alpar@156
   596
    /// Add a node map reading rule to the reader.
deba@127
   597
    template <typename Map>
deba@127
   598
    DigraphReader& nodeMap(const std::string& caption, Map& map) {
deba@127
   599
      checkConcept<concepts::WriteMap<Node, typename Map::Value>, Map>();
alpar@209
   600
      _reader_bits::MapStorageBase<Node>* storage =
alpar@209
   601
        new _reader_bits::MapStorage<Node, Map>(map);
deba@127
   602
      _node_maps.push_back(std::make_pair(caption, storage));
deba@127
   603
      return *this;
deba@127
   604
    }
deba@127
   605
alpar@156
   606
    /// \brief Node map reading rule
alpar@156
   607
    ///
alpar@156
   608
    /// Add a node map reading rule with specialized converter to the
alpar@156
   609
    /// reader.
deba@127
   610
    template <typename Map, typename Converter>
alpar@209
   611
    DigraphReader& nodeMap(const std::string& caption, Map& map,
alpar@209
   612
                           const Converter& converter = Converter()) {
deba@127
   613
      checkConcept<concepts::WriteMap<Node, typename Map::Value>, Map>();
alpar@209
   614
      _reader_bits::MapStorageBase<Node>* storage =
alpar@209
   615
        new _reader_bits::MapStorage<Node, Map, Converter>(map, converter);
deba@127
   616
      _node_maps.push_back(std::make_pair(caption, storage));
deba@127
   617
      return *this;
deba@127
   618
    }
deba@127
   619
alpar@156
   620
    /// \brief Arc map reading rule
alpar@156
   621
    ///
alpar@156
   622
    /// Add an arc map reading rule to the reader.
deba@127
   623
    template <typename Map>
deba@127
   624
    DigraphReader& arcMap(const std::string& caption, Map& map) {
deba@127
   625
      checkConcept<concepts::WriteMap<Arc, typename Map::Value>, Map>();
alpar@209
   626
      _reader_bits::MapStorageBase<Arc>* storage =
alpar@209
   627
        new _reader_bits::MapStorage<Arc, Map>(map);
deba@127
   628
      _arc_maps.push_back(std::make_pair(caption, storage));
deba@127
   629
      return *this;
deba@127
   630
    }
deba@127
   631
alpar@156
   632
    /// \brief Arc map reading rule
alpar@156
   633
    ///
alpar@156
   634
    /// Add an arc map reading rule with specialized converter to the
alpar@156
   635
    /// reader.
deba@127
   636
    template <typename Map, typename Converter>
alpar@209
   637
    DigraphReader& arcMap(const std::string& caption, Map& map,
alpar@209
   638
                          const Converter& converter = Converter()) {
deba@127
   639
      checkConcept<concepts::WriteMap<Arc, typename Map::Value>, Map>();
alpar@209
   640
      _reader_bits::MapStorageBase<Arc>* storage =
alpar@209
   641
        new _reader_bits::MapStorage<Arc, Map, Converter>(map, converter);
deba@127
   642
      _arc_maps.push_back(std::make_pair(caption, storage));
deba@127
   643
      return *this;
deba@127
   644
    }
deba@127
   645
alpar@156
   646
    /// \brief Attribute reading rule
alpar@156
   647
    ///
alpar@156
   648
    /// Add an attribute reading rule to the reader.
deba@127
   649
    template <typename Value>
deba@127
   650
    DigraphReader& attribute(const std::string& caption, Value& value) {
alpar@209
   651
      _reader_bits::ValueStorageBase* storage =
alpar@209
   652
        new _reader_bits::ValueStorage<Value>(value);
deba@127
   653
      _attributes.insert(std::make_pair(caption, storage));
deba@127
   654
      return *this;
deba@127
   655
    }
deba@127
   656
alpar@156
   657
    /// \brief Attribute reading rule
alpar@156
   658
    ///
alpar@156
   659
    /// Add an attribute reading rule with specialized converter to the
alpar@156
   660
    /// reader.
deba@127
   661
    template <typename Value, typename Converter>
alpar@209
   662
    DigraphReader& attribute(const std::string& caption, Value& value,
alpar@209
   663
                             const Converter& converter = Converter()) {
alpar@209
   664
      _reader_bits::ValueStorageBase* storage =
alpar@209
   665
        new _reader_bits::ValueStorage<Value, Converter>(value, converter);
deba@127
   666
      _attributes.insert(std::make_pair(caption, storage));
deba@127
   667
      return *this;
deba@127
   668
    }
deba@127
   669
alpar@156
   670
    /// \brief Node reading rule
alpar@156
   671
    ///
alpar@156
   672
    /// Add a node reading rule to reader.
deba@127
   673
    DigraphReader& node(const std::string& caption, Node& node) {
deba@127
   674
      typedef _reader_bits::MapLookUpConverter<Node> Converter;
deba@127
   675
      Converter converter(_node_index);
alpar@209
   676
      _reader_bits::ValueStorageBase* storage =
alpar@209
   677
        new _reader_bits::ValueStorage<Node, Converter>(node, converter);
deba@127
   678
      _attributes.insert(std::make_pair(caption, storage));
deba@127
   679
      return *this;
deba@127
   680
    }
deba@127
   681
alpar@156
   682
    /// \brief Arc reading rule
alpar@156
   683
    ///
alpar@156
   684
    /// Add an arc reading rule to reader.
deba@127
   685
    DigraphReader& arc(const std::string& caption, Arc& arc) {
deba@127
   686
      typedef _reader_bits::MapLookUpConverter<Arc> Converter;
deba@127
   687
      Converter converter(_arc_index);
alpar@209
   688
      _reader_bits::ValueStorageBase* storage =
alpar@209
   689
        new _reader_bits::ValueStorage<Arc, Converter>(arc, converter);
deba@127
   690
      _attributes.insert(std::make_pair(caption, storage));
deba@127
   691
      return *this;
deba@127
   692
    }
deba@127
   693
alpar@156
   694
    /// @}
alpar@156
   695
alpar@156
   696
    /// \name Select section by name
alpar@156
   697
    /// @{
alpar@156
   698
alpar@156
   699
    /// \brief Set \c \@nodes section to be read
alpar@156
   700
    ///
alpar@156
   701
    /// Set \c \@nodes section to be read
deba@127
   702
    DigraphReader& nodes(const std::string& caption) {
deba@127
   703
      _nodes_caption = caption;
deba@127
   704
      return *this;
deba@127
   705
    }
deba@127
   706
alpar@156
   707
    /// \brief Set \c \@arcs section to be read
alpar@156
   708
    ///
alpar@156
   709
    /// Set \c \@arcs section to be read
deba@127
   710
    DigraphReader& arcs(const std::string& caption) {
deba@127
   711
      _arcs_caption = caption;
deba@127
   712
      return *this;
deba@127
   713
    }
deba@127
   714
alpar@156
   715
    /// \brief Set \c \@attributes section to be read
alpar@156
   716
    ///
alpar@156
   717
    /// Set \c \@attributes section to be read
deba@127
   718
    DigraphReader& attributes(const std::string& caption) {
deba@127
   719
      _attributes_caption = caption;
deba@127
   720
      return *this;
deba@127
   721
    }
deba@127
   722
alpar@156
   723
    /// @}
alpar@156
   724
alpar@156
   725
    /// \name Using previously constructed node or arc set
alpar@156
   726
    /// @{
alpar@156
   727
alpar@156
   728
    /// \brief Use previously constructed node set
alpar@156
   729
    ///
alpar@156
   730
    /// Use previously constructed node set, and specify the node
alpar@156
   731
    /// label map.
deba@127
   732
    template <typename Map>
deba@127
   733
    DigraphReader& useNodes(const Map& map) {
deba@127
   734
      checkConcept<concepts::ReadMap<Node, typename Map::Value>, Map>();
alpar@209
   735
      LEMON_ASSERT(!_use_nodes, "Multiple usage of useNodes() member");
deba@127
   736
      _use_nodes = true;
deba@127
   737
      _writer_bits::DefaultConverter<typename Map::Value> converter;
deba@127
   738
      for (NodeIt n(_digraph); n != INVALID; ++n) {
alpar@209
   739
        _node_index.insert(std::make_pair(converter(map[n]), n));
deba@127
   740
      }
deba@127
   741
      return *this;
deba@127
   742
    }
deba@127
   743
alpar@156
   744
    /// \brief Use previously constructed node set
alpar@156
   745
    ///
alpar@156
   746
    /// Use previously constructed node set, and specify the node
alpar@156
   747
    /// label map and a functor which converts the label map values to
kpeter@192
   748
    /// \c std::string.
deba@127
   749
    template <typename Map, typename Converter>
alpar@209
   750
    DigraphReader& useNodes(const Map& map,
alpar@209
   751
                            const Converter& converter = Converter()) {
deba@127
   752
      checkConcept<concepts::ReadMap<Node, typename Map::Value>, Map>();
alpar@209
   753
      LEMON_ASSERT(!_use_nodes, "Multiple usage of useNodes() member");
deba@127
   754
      _use_nodes = true;
deba@127
   755
      for (NodeIt n(_digraph); n != INVALID; ++n) {
alpar@209
   756
        _node_index.insert(std::make_pair(converter(map[n]), n));
deba@127
   757
      }
deba@127
   758
      return *this;
deba@127
   759
    }
deba@127
   760
alpar@156
   761
    /// \brief Use previously constructed arc set
alpar@156
   762
    ///
alpar@156
   763
    /// Use previously constructed arc set, and specify the arc
alpar@156
   764
    /// label map.
deba@127
   765
    template <typename Map>
deba@127
   766
    DigraphReader& useArcs(const Map& map) {
deba@127
   767
      checkConcept<concepts::ReadMap<Arc, typename Map::Value>, Map>();
deba@127
   768
      LEMON_ASSERT(!_use_arcs, "Multiple usage of useArcs() member");
deba@127
   769
      _use_arcs = true;
deba@127
   770
      _writer_bits::DefaultConverter<typename Map::Value> converter;
deba@127
   771
      for (ArcIt a(_digraph); a != INVALID; ++a) {
alpar@209
   772
        _arc_index.insert(std::make_pair(converter(map[a]), a));
deba@127
   773
      }
deba@127
   774
      return *this;
deba@127
   775
    }
deba@127
   776
alpar@156
   777
    /// \brief Use previously constructed arc set
alpar@156
   778
    ///
alpar@156
   779
    /// Use previously constructed arc set, and specify the arc
alpar@156
   780
    /// label map and a functor which converts the label map values to
kpeter@192
   781
    /// \c std::string.
deba@127
   782
    template <typename Map, typename Converter>
alpar@209
   783
    DigraphReader& useArcs(const Map& map,
alpar@209
   784
                           const Converter& converter = Converter()) {
deba@127
   785
      checkConcept<concepts::ReadMap<Arc, typename Map::Value>, Map>();
alpar@209
   786
      LEMON_ASSERT(!_use_arcs, "Multiple usage of useArcs() member");
deba@127
   787
      _use_arcs = true;
deba@127
   788
      for (ArcIt a(_digraph); a != INVALID; ++a) {
alpar@209
   789
        _arc_index.insert(std::make_pair(converter(map[a]), a));
deba@127
   790
      }
deba@127
   791
      return *this;
deba@127
   792
    }
deba@127
   793
deba@188
   794
    /// \brief Skips the reading of node section
deba@188
   795
    ///
deba@188
   796
    /// Omit the reading of the node section. This implies that each node
kpeter@192
   797
    /// map reading rule will be abandoned, and the nodes of the graph
deba@188
   798
    /// will not be constructed, which usually cause that the arc set
kpeter@192
   799
    /// could not be read due to lack of node name resolving.
kpeter@192
   800
    /// Therefore \c skipArcs() function should also be used, or
kpeter@192
   801
    /// \c useNodes() should be used to specify the label of the nodes.
deba@188
   802
    DigraphReader& skipNodes() {
alpar@209
   803
      LEMON_ASSERT(!_skip_nodes, "Skip nodes already set");
deba@188
   804
      _skip_nodes = true;
deba@188
   805
      return *this;
deba@188
   806
    }
deba@188
   807
deba@188
   808
    /// \brief Skips the reading of arc section
deba@188
   809
    ///
deba@188
   810
    /// Omit the reading of the arc section. This implies that each arc
kpeter@192
   811
    /// map reading rule will be abandoned, and the arcs of the graph
deba@188
   812
    /// will not be constructed.
deba@188
   813
    DigraphReader& skipArcs() {
alpar@209
   814
      LEMON_ASSERT(!_skip_arcs, "Skip arcs already set");
deba@188
   815
      _skip_arcs = true;
deba@188
   816
      return *this;
deba@188
   817
    }
deba@188
   818
alpar@156
   819
    /// @}
alpar@156
   820
deba@127
   821
  private:
deba@127
   822
deba@127
   823
    bool readLine() {
deba@127
   824
      std::string str;
deba@127
   825
      while(++line_num, std::getline(*_is, str)) {
alpar@209
   826
        line.clear(); line.str(str);
alpar@209
   827
        char c;
alpar@209
   828
        if (line >> std::ws >> c && c != '#') {
alpar@209
   829
          line.putback(c);
alpar@209
   830
          return true;
alpar@209
   831
        }
deba@127
   832
      }
deba@127
   833
      return false;
deba@127
   834
    }
deba@127
   835
deba@127
   836
    bool readSuccess() {
deba@127
   837
      return static_cast<bool>(*_is);
deba@127
   838
    }
alpar@209
   839
deba@127
   840
    void skipSection() {
deba@127
   841
      char c;
deba@127
   842
      while (readSuccess() && line >> c && c != '@') {
alpar@209
   843
        readLine();
deba@127
   844
      }
deba@127
   845
      line.putback(c);
deba@127
   846
    }
deba@127
   847
deba@127
   848
    void readNodes() {
deba@127
   849
deba@127
   850
      std::vector<int> map_index(_node_maps.size());
deba@127
   851
      int map_num, label_index;
deba@127
   852
deba@186
   853
      char c;
deba@186
   854
      if (!readLine() || !(line >> c) || c == '@') {
alpar@209
   855
        if (readSuccess() && line) line.putback(c);
alpar@209
   856
        if (!_node_maps.empty())
deba@290
   857
          throw FormatError("Cannot find map names");
alpar@209
   858
        return;
deba@186
   859
      }
deba@186
   860
      line.putback(c);
deba@186
   861
deba@127
   862
      {
alpar@209
   863
        std::map<std::string, int> maps;
alpar@209
   864
alpar@209
   865
        std::string map;
alpar@209
   866
        int index = 0;
alpar@209
   867
        while (_reader_bits::readToken(line, map)) {
alpar@209
   868
          if (maps.find(map) != maps.end()) {
alpar@209
   869
            std::ostringstream msg;
alpar@209
   870
            msg << "Multiple occurence of node map: " << map;
deba@290
   871
            throw FormatError(msg.str());
alpar@209
   872
          }
alpar@209
   873
          maps.insert(std::make_pair(map, index));
alpar@209
   874
          ++index;
alpar@209
   875
        }
alpar@209
   876
alpar@209
   877
        for (int i = 0; i < static_cast<int>(_node_maps.size()); ++i) {
alpar@209
   878
          std::map<std::string, int>::iterator jt =
alpar@209
   879
            maps.find(_node_maps[i].first);
alpar@209
   880
          if (jt == maps.end()) {
alpar@209
   881
            std::ostringstream msg;
alpar@209
   882
            msg << "Map not found in file: " << _node_maps[i].first;
deba@290
   883
            throw FormatError(msg.str());
alpar@209
   884
          }
alpar@209
   885
          map_index[i] = jt->second;
alpar@209
   886
        }
alpar@209
   887
alpar@209
   888
        {
alpar@209
   889
          std::map<std::string, int>::iterator jt = maps.find("label");
alpar@209
   890
          if (jt != maps.end()) {
alpar@209
   891
            label_index = jt->second;
alpar@209
   892
          } else {
alpar@209
   893
            label_index = -1;
alpar@209
   894
          }
alpar@209
   895
        }
alpar@209
   896
        map_num = maps.size();
deba@127
   897
      }
deba@127
   898
deba@127
   899
      while (readLine() && line >> c && c != '@') {
alpar@209
   900
        line.putback(c);
alpar@209
   901
alpar@209
   902
        std::vector<std::string> tokens(map_num);
alpar@209
   903
        for (int i = 0; i < map_num; ++i) {
alpar@209
   904
          if (!_reader_bits::readToken(line, tokens[i])) {
alpar@209
   905
            std::ostringstream msg;
alpar@209
   906
            msg << "Column not found (" << i + 1 << ")";
deba@290
   907
            throw FormatError(msg.str());
alpar@209
   908
          }
alpar@209
   909
        }
alpar@209
   910
        if (line >> std::ws >> c)
deba@290
   911
          throw FormatError("Extra character on the end of line");
alpar@209
   912
alpar@209
   913
        Node n;
alpar@209
   914
        if (!_use_nodes) {
alpar@209
   915
          n = _digraph.addNode();
alpar@209
   916
          if (label_index != -1)
alpar@209
   917
            _node_index.insert(std::make_pair(tokens[label_index], n));
alpar@209
   918
        } else {
alpar@209
   919
          if (label_index == -1)
deba@290
   920
            throw FormatError("Label map not found in file");
alpar@209
   921
          typename std::map<std::string, Node>::iterator it =
alpar@209
   922
            _node_index.find(tokens[label_index]);
alpar@209
   923
          if (it == _node_index.end()) {
alpar@209
   924
            std::ostringstream msg;
alpar@209
   925
            msg << "Node with label not found: " << tokens[label_index];
deba@290
   926
            throw FormatError(msg.str());
alpar@209
   927
          }
alpar@209
   928
          n = it->second;
alpar@209
   929
        }
alpar@209
   930
alpar@209
   931
        for (int i = 0; i < static_cast<int>(_node_maps.size()); ++i) {
alpar@209
   932
          _node_maps[i].second->set(n, tokens[map_index[i]]);
alpar@209
   933
        }
deba@127
   934
deba@127
   935
      }
deba@127
   936
      if (readSuccess()) {
alpar@209
   937
        line.putback(c);
deba@127
   938
      }
deba@127
   939
    }
deba@127
   940
deba@127
   941
    void readArcs() {
deba@127
   942
deba@127
   943
      std::vector<int> map_index(_arc_maps.size());
deba@127
   944
      int map_num, label_index;
deba@127
   945
deba@186
   946
      char c;
deba@186
   947
      if (!readLine() || !(line >> c) || c == '@') {
alpar@209
   948
        if (readSuccess() && line) line.putback(c);
alpar@209
   949
        if (!_arc_maps.empty())
deba@290
   950
          throw FormatError("Cannot find map names");
alpar@209
   951
        return;
deba@186
   952
      }
deba@186
   953
      line.putback(c);
alpar@209
   954
deba@127
   955
      {
alpar@209
   956
        std::map<std::string, int> maps;
alpar@209
   957
alpar@209
   958
        std::string map;
alpar@209
   959
        int index = 0;
alpar@209
   960
        while (_reader_bits::readToken(line, map)) {
alpar@209
   961
          if (maps.find(map) != maps.end()) {
alpar@209
   962
            std::ostringstream msg;
alpar@209
   963
            msg << "Multiple occurence of arc map: " << map;
deba@290
   964
            throw FormatError(msg.str());
alpar@209
   965
          }
alpar@209
   966
          maps.insert(std::make_pair(map, index));
alpar@209
   967
          ++index;
alpar@209
   968
        }
alpar@209
   969
alpar@209
   970
        for (int i = 0; i < static_cast<int>(_arc_maps.size()); ++i) {
alpar@209
   971
          std::map<std::string, int>::iterator jt =
alpar@209
   972
            maps.find(_arc_maps[i].first);
alpar@209
   973
          if (jt == maps.end()) {
alpar@209
   974
            std::ostringstream msg;
alpar@209
   975
            msg << "Map not found in file: " << _arc_maps[i].first;
deba@290
   976
            throw FormatError(msg.str());
alpar@209
   977
          }
alpar@209
   978
          map_index[i] = jt->second;
alpar@209
   979
        }
alpar@209
   980
alpar@209
   981
        {
alpar@209
   982
          std::map<std::string, int>::iterator jt = maps.find("label");
alpar@209
   983
          if (jt != maps.end()) {
alpar@209
   984
            label_index = jt->second;
alpar@209
   985
          } else {
alpar@209
   986
            label_index = -1;
alpar@209
   987
          }
alpar@209
   988
        }
alpar@209
   989
        map_num = maps.size();
deba@127
   990
      }
deba@127
   991
deba@127
   992
      while (readLine() && line >> c && c != '@') {
alpar@209
   993
        line.putback(c);
alpar@209
   994
alpar@209
   995
        std::string source_token;
alpar@209
   996
        std::string target_token;
alpar@209
   997
alpar@209
   998
        if (!_reader_bits::readToken(line, source_token))
deba@290
   999
          throw FormatError("Source not found");
alpar@209
  1000
alpar@209
  1001
        if (!_reader_bits::readToken(line, target_token))
deba@290
  1002
          throw FormatError("Target not found");
alpar@209
  1003
alpar@209
  1004
        std::vector<std::string> tokens(map_num);
alpar@209
  1005
        for (int i = 0; i < map_num; ++i) {
alpar@209
  1006
          if (!_reader_bits::readToken(line, tokens[i])) {
alpar@209
  1007
            std::ostringstream msg;
alpar@209
  1008
            msg << "Column not found (" << i + 1 << ")";
deba@290
  1009
            throw FormatError(msg.str());
alpar@209
  1010
          }
alpar@209
  1011
        }
alpar@209
  1012
        if (line >> std::ws >> c)
deba@290
  1013
          throw FormatError("Extra character on the end of line");
alpar@209
  1014
alpar@209
  1015
        Arc a;
alpar@209
  1016
        if (!_use_arcs) {
deba@127
  1017
deba@127
  1018
          typename NodeIndex::iterator it;
alpar@209
  1019
deba@127
  1020
          it = _node_index.find(source_token);
deba@127
  1021
          if (it == _node_index.end()) {
deba@127
  1022
            std::ostringstream msg;
deba@127
  1023
            msg << "Item not found: " << source_token;
deba@290
  1024
            throw FormatError(msg.str());
deba@127
  1025
          }
deba@127
  1026
          Node source = it->second;
deba@127
  1027
deba@127
  1028
          it = _node_index.find(target_token);
alpar@209
  1029
          if (it == _node_index.end()) {
alpar@209
  1030
            std::ostringstream msg;
deba@127
  1031
            msg << "Item not found: " << target_token;
deba@290
  1032
            throw FormatError(msg.str());
alpar@209
  1033
          }
alpar@209
  1034
          Node target = it->second;
alpar@209
  1035
alpar@209
  1036
          a = _digraph.addArc(source, target);
alpar@209
  1037
          if (label_index != -1)
alpar@209
  1038
            _arc_index.insert(std::make_pair(tokens[label_index], a));
alpar@209
  1039
        } else {
alpar@209
  1040
          if (label_index == -1)
deba@290
  1041
            throw FormatError("Label map not found in file");
alpar@209
  1042
          typename std::map<std::string, Arc>::iterator it =
alpar@209
  1043
            _arc_index.find(tokens[label_index]);
alpar@209
  1044
          if (it == _arc_index.end()) {
alpar@209
  1045
            std::ostringstream msg;
alpar@209
  1046
            msg << "Arc with label not found: " << tokens[label_index];
deba@290
  1047
            throw FormatError(msg.str());
alpar@209
  1048
          }
alpar@209
  1049
          a = it->second;
alpar@209
  1050
        }
alpar@209
  1051
alpar@209
  1052
        for (int i = 0; i < static_cast<int>(_arc_maps.size()); ++i) {
alpar@209
  1053
          _arc_maps[i].second->set(a, tokens[map_index[i]]);
alpar@209
  1054
        }
deba@127
  1055
deba@127
  1056
      }
deba@127
  1057
      if (readSuccess()) {
alpar@209
  1058
        line.putback(c);
deba@127
  1059
      }
deba@127
  1060
    }
deba@127
  1061
deba@127
  1062
    void readAttributes() {
deba@127
  1063
deba@127
  1064
      std::set<std::string> read_attr;
deba@127
  1065
deba@127
  1066
      char c;
deba@127
  1067
      while (readLine() && line >> c && c != '@') {
alpar@209
  1068
        line.putback(c);
alpar@209
  1069
alpar@209
  1070
        std::string attr, token;
alpar@209
  1071
        if (!_reader_bits::readToken(line, attr))
deba@290
  1072
          throw FormatError("Attribute name not found");
alpar@209
  1073
        if (!_reader_bits::readToken(line, token))
deba@290
  1074
          throw FormatError("Attribute value not found");
alpar@209
  1075
        if (line >> c)
deba@290
  1076
          throw FormatError("Extra character on the end of line");
alpar@209
  1077
alpar@209
  1078
        {
alpar@209
  1079
          std::set<std::string>::iterator it = read_attr.find(attr);
alpar@209
  1080
          if (it != read_attr.end()) {
alpar@209
  1081
            std::ostringstream msg;
alpar@209
  1082
            msg << "Multiple occurence of attribute " << attr;
deba@290
  1083
            throw FormatError(msg.str());
alpar@209
  1084
          }
alpar@209
  1085
          read_attr.insert(attr);
alpar@209
  1086
        }
alpar@209
  1087
alpar@209
  1088
        {
alpar@209
  1089
          typename Attributes::iterator it = _attributes.lower_bound(attr);
alpar@209
  1090
          while (it != _attributes.end() && it->first == attr) {
alpar@209
  1091
            it->second->set(token);
alpar@209
  1092
            ++it;
alpar@209
  1093
          }
alpar@209
  1094
        }
deba@127
  1095
deba@127
  1096
      }
deba@127
  1097
      if (readSuccess()) {
alpar@209
  1098
        line.putback(c);
deba@127
  1099
      }
deba@127
  1100
      for (typename Attributes::iterator it = _attributes.begin();
alpar@209
  1101
           it != _attributes.end(); ++it) {
alpar@209
  1102
        if (read_attr.find(it->first) == read_attr.end()) {
alpar@209
  1103
          std::ostringstream msg;
alpar@209
  1104
          msg << "Attribute not found in file: " << it->first;
deba@290
  1105
          throw FormatError(msg.str());
alpar@209
  1106
        }
deba@127
  1107
      }
deba@127
  1108
    }
deba@127
  1109
deba@127
  1110
  public:
alpar@156
  1111
alpar@209
  1112
    /// \name Execution of the reader
alpar@156
  1113
    /// @{
alpar@156
  1114
alpar@156
  1115
    /// \brief Start the batch processing
alpar@156
  1116
    ///
alpar@156
  1117
    /// This function starts the batch processing
deba@127
  1118
    void run() {
deba@127
  1119
      LEMON_ASSERT(_is != 0, "This reader assigned to an other reader");
deba@163
  1120
      if (!*_is) {
deba@290
  1121
        throw FormatError("Cannot find file");
deba@163
  1122
      }
alpar@209
  1123
deba@188
  1124
      bool nodes_done = _skip_nodes;
deba@188
  1125
      bool arcs_done = _skip_arcs;
deba@127
  1126
      bool attributes_done = false;
deba@127
  1127
alpar@209
  1128
      line_num = 0;
deba@127
  1129
      readLine();
deba@172
  1130
      skipSection();
deba@127
  1131
deba@127
  1132
      while (readSuccess()) {
alpar@209
  1133
        try {
alpar@209
  1134
          char c;
alpar@209
  1135
          std::string section, caption;
alpar@209
  1136
          line >> c;
alpar@209
  1137
          _reader_bits::readToken(line, section);
alpar@209
  1138
          _reader_bits::readToken(line, caption);
alpar@209
  1139
alpar@209
  1140
          if (line >> c)
deba@290
  1141
            throw FormatError("Extra character on the end of line");
alpar@209
  1142
alpar@209
  1143
          if (section == "nodes" && !nodes_done) {
alpar@209
  1144
            if (_nodes_caption.empty() || _nodes_caption == caption) {
alpar@209
  1145
              readNodes();
alpar@209
  1146
              nodes_done = true;
alpar@209
  1147
            }
alpar@209
  1148
          } else if ((section == "arcs" || section == "edges") &&
alpar@209
  1149
                     !arcs_done) {
alpar@209
  1150
            if (_arcs_caption.empty() || _arcs_caption == caption) {
alpar@209
  1151
              readArcs();
alpar@209
  1152
              arcs_done = true;
alpar@209
  1153
            }
alpar@209
  1154
          } else if (section == "attributes" && !attributes_done) {
alpar@209
  1155
            if (_attributes_caption.empty() || _attributes_caption == caption) {
alpar@209
  1156
              readAttributes();
alpar@209
  1157
              attributes_done = true;
alpar@209
  1158
            }
alpar@209
  1159
          } else {
alpar@209
  1160
            readLine();
alpar@209
  1161
            skipSection();
alpar@209
  1162
          }
deba@290
  1163
        } catch (FormatError& error) {
alpar@209
  1164
          error.line(line_num);
deba@290
  1165
          error.file(_filename);
alpar@209
  1166
          throw;
alpar@209
  1167
        }
deba@127
  1168
      }
deba@127
  1169
deba@127
  1170
      if (!nodes_done) {
deba@290
  1171
        throw FormatError("Section @nodes not found");
deba@127
  1172
      }
deba@127
  1173
deba@127
  1174
      if (!arcs_done) {
deba@290
  1175
        throw FormatError("Section @arcs not found");
deba@127
  1176
      }
deba@127
  1177
deba@127
  1178
      if (!attributes_done && !_attributes.empty()) {
deba@290
  1179
        throw FormatError("Section @attributes not found");
deba@127
  1180
      }
deba@127
  1181
deba@127
  1182
    }
alpar@156
  1183
alpar@156
  1184
    /// @}
alpar@209
  1185
deba@127
  1186
  };
deba@127
  1187
kpeter@192
  1188
  /// \brief Return a \ref DigraphReader class
alpar@209
  1189
  ///
kpeter@192
  1190
  /// This function just returns a \ref DigraphReader class.
alpar@156
  1191
  /// \relates DigraphReader
deba@127
  1192
  template <typename Digraph>
deba@127
  1193
  DigraphReader<Digraph> digraphReader(std::istream& is, Digraph& digraph) {
deba@163
  1194
    DigraphReader<Digraph> tmp(is, digraph);
deba@163
  1195
    return tmp;
deba@127
  1196
  }
deba@127
  1197
kpeter@192
  1198
  /// \brief Return a \ref DigraphReader class
alpar@209
  1199
  ///
kpeter@192
  1200
  /// This function just returns a \ref DigraphReader class.
alpar@156
  1201
  /// \relates DigraphReader
deba@127
  1202
  template <typename Digraph>
alpar@209
  1203
  DigraphReader<Digraph> digraphReader(const std::string& fn,
alpar@209
  1204
                                       Digraph& digraph) {
deba@163
  1205
    DigraphReader<Digraph> tmp(fn, digraph);
deba@163
  1206
    return tmp;
deba@127
  1207
  }
deba@127
  1208
kpeter@192
  1209
  /// \brief Return a \ref DigraphReader class
alpar@209
  1210
  ///
kpeter@192
  1211
  /// This function just returns a \ref DigraphReader class.
alpar@156
  1212
  /// \relates DigraphReader
deba@127
  1213
  template <typename Digraph>
deba@127
  1214
  DigraphReader<Digraph> digraphReader(const char* fn, Digraph& digraph) {
deba@163
  1215
    DigraphReader<Digraph> tmp(fn, digraph);
deba@163
  1216
    return tmp;
deba@127
  1217
  }
deba@165
  1218
deba@190
  1219
  template <typename Graph>
deba@190
  1220
  class GraphReader;
deba@190
  1221
deba@190
  1222
  template <typename Graph>
alpar@209
  1223
  GraphReader<Graph> graphReader(std::istream& is, Graph& graph);
deba@190
  1224
deba@190
  1225
  template <typename Graph>
alpar@209
  1226
  GraphReader<Graph> graphReader(const std::string& fn, Graph& graph);
deba@190
  1227
deba@190
  1228
  template <typename Graph>
alpar@209
  1229
  GraphReader<Graph> graphReader(const char *fn, Graph& graph);
deba@190
  1230
deba@165
  1231
  /// \ingroup lemon_io
alpar@209
  1232
  ///
kpeter@192
  1233
  /// \brief \ref lgf-format "LGF" reader for undirected graphs
deba@165
  1234
  ///
deba@165
  1235
  /// This utility reads an \ref lgf-format "LGF" file.
kpeter@192
  1236
  ///
kpeter@192
  1237
  /// It can be used almost the same way as \c DigraphReader.
kpeter@192
  1238
  /// The only difference is that this class can handle edges and
kpeter@192
  1239
  /// edge maps as well as arcs and arc maps.
deba@201
  1240
  ///
deba@201
  1241
  /// The columns in the \c \@edges (or \c \@arcs) section are the
deba@201
  1242
  /// edge maps. However, if there are two maps with the same name
deba@201
  1243
  /// prefixed with \c '+' and \c '-', then these can be read into an
deba@201
  1244
  /// arc map.  Similarly, an attribute can be read into an arc, if
deba@201
  1245
  /// it's value is an edge label prefixed with \c '+' or \c '-'.
deba@165
  1246
  template <typename _Graph>
deba@165
  1247
  class GraphReader {
deba@165
  1248
  public:
deba@165
  1249
deba@165
  1250
    typedef _Graph Graph;
deba@165
  1251
    TEMPLATE_GRAPH_TYPEDEFS(Graph);
alpar@209
  1252
deba@165
  1253
  private:
deba@165
  1254
deba@165
  1255
    std::istream* _is;
deba@165
  1256
    bool local_is;
deba@290
  1257
    std::string _filename;
deba@165
  1258
deba@165
  1259
    Graph& _graph;
deba@165
  1260
deba@165
  1261
    std::string _nodes_caption;
deba@165
  1262
    std::string _edges_caption;
deba@165
  1263
    std::string _attributes_caption;
deba@165
  1264
deba@165
  1265
    typedef std::map<std::string, Node> NodeIndex;
deba@165
  1266
    NodeIndex _node_index;
deba@165
  1267
    typedef std::map<std::string, Edge> EdgeIndex;
deba@165
  1268
    EdgeIndex _edge_index;
alpar@209
  1269
alpar@209
  1270
    typedef std::vector<std::pair<std::string,
alpar@209
  1271
      _reader_bits::MapStorageBase<Node>*> > NodeMaps;
alpar@209
  1272
    NodeMaps _node_maps;
deba@165
  1273
deba@165
  1274
    typedef std::vector<std::pair<std::string,
deba@165
  1275
      _reader_bits::MapStorageBase<Edge>*> > EdgeMaps;
deba@165
  1276
    EdgeMaps _edge_maps;
deba@165
  1277
alpar@209
  1278
    typedef std::multimap<std::string, _reader_bits::ValueStorageBase*>
deba@165
  1279
      Attributes;
deba@165
  1280
    Attributes _attributes;
deba@165
  1281
deba@165
  1282
    bool _use_nodes;
deba@165
  1283
    bool _use_edges;
deba@165
  1284
deba@188
  1285
    bool _skip_nodes;
deba@188
  1286
    bool _skip_edges;
deba@188
  1287
deba@165
  1288
    int line_num;
deba@165
  1289
    std::istringstream line;
deba@165
  1290
deba@165
  1291
  public:
deba@165
  1292
deba@165
  1293
    /// \brief Constructor
deba@165
  1294
    ///
kpeter@192
  1295
    /// Construct an undirected graph reader, which reads from the given
deba@165
  1296
    /// input stream.
alpar@209
  1297
    GraphReader(std::istream& is, Graph& graph)
deba@165
  1298
      : _is(&is), local_is(false), _graph(graph),
alpar@209
  1299
        _use_nodes(false), _use_edges(false),
alpar@209
  1300
        _skip_nodes(false), _skip_edges(false) {}
deba@165
  1301
deba@165
  1302
    /// \brief Constructor
deba@165
  1303
    ///
kpeter@192
  1304
    /// Construct an undirected graph reader, which reads from the given
deba@165
  1305
    /// file.
alpar@209
  1306
    GraphReader(const std::string& fn, Graph& graph)
deba@290
  1307
      : _is(new std::ifstream(fn.c_str())), local_is(true),
deba@290
  1308
        _filename(fn), _graph(graph),
kpeter@212
  1309
        _use_nodes(false), _use_edges(false),
deba@290
  1310
        _skip_nodes(false), _skip_edges(false) {
deba@290
  1311
      if (!(*_is)) throw IoError(fn, "Cannot open file");
deba@290
  1312
    }
alpar@209
  1313
deba@165
  1314
    /// \brief Constructor
deba@165
  1315
    ///
kpeter@192
  1316
    /// Construct an undirected graph reader, which reads from the given
deba@165
  1317
    /// file.
alpar@209
  1318
    GraphReader(const char* fn, Graph& graph)
deba@290
  1319
      : _is(new std::ifstream(fn)), local_is(true),
deba@290
  1320
        _filename(fn), _graph(graph),
kpeter@212
  1321
        _use_nodes(false), _use_edges(false),
deba@290
  1322
        _skip_nodes(false), _skip_edges(false) {
deba@290
  1323
      if (!(*_is)) throw IoError(fn, "Cannot open file");
deba@290
  1324
    }
deba@165
  1325
deba@165
  1326
    /// \brief Destructor
deba@165
  1327
    ~GraphReader() {
alpar@209
  1328
      for (typename NodeMaps::iterator it = _node_maps.begin();
alpar@209
  1329
           it != _node_maps.end(); ++it) {
alpar@209
  1330
        delete it->second;
deba@165
  1331
      }
deba@165
  1332
alpar@209
  1333
      for (typename EdgeMaps::iterator it = _edge_maps.begin();
alpar@209
  1334
           it != _edge_maps.end(); ++it) {
alpar@209
  1335
        delete it->second;
deba@165
  1336
      }
deba@165
  1337
alpar@209
  1338
      for (typename Attributes::iterator it = _attributes.begin();
alpar@209
  1339
           it != _attributes.end(); ++it) {
alpar@209
  1340
        delete it->second;
deba@165
  1341
      }
deba@165
  1342
deba@165
  1343
      if (local_is) {
alpar@209
  1344
        delete _is;
deba@165
  1345
      }
deba@165
  1346
deba@165
  1347
    }
deba@165
  1348
deba@165
  1349
  private:
alpar@209
  1350
    friend GraphReader<Graph> graphReader<>(std::istream& is, Graph& graph);
alpar@209
  1351
    friend GraphReader<Graph> graphReader<>(const std::string& fn,
alpar@209
  1352
                                            Graph& graph);
alpar@209
  1353
    friend GraphReader<Graph> graphReader<>(const char *fn, Graph& graph);
alpar@209
  1354
alpar@209
  1355
    GraphReader(GraphReader& other)
deba@190
  1356
      : _is(other._is), local_is(other.local_is), _graph(other._graph),
alpar@209
  1357
        _use_nodes(other._use_nodes), _use_edges(other._use_edges),
alpar@209
  1358
        _skip_nodes(other._skip_nodes), _skip_edges(other._skip_edges) {
deba@190
  1359
deba@190
  1360
      other._is = 0;
deba@190
  1361
      other.local_is = false;
alpar@209
  1362
deba@190
  1363
      _node_index.swap(other._node_index);
deba@190
  1364
      _edge_index.swap(other._edge_index);
deba@190
  1365
deba@190
  1366
      _node_maps.swap(other._node_maps);
deba@190
  1367
      _edge_maps.swap(other._edge_maps);
deba@190
  1368
      _attributes.swap(other._attributes);
deba@190
  1369
deba@190
  1370
      _nodes_caption = other._nodes_caption;
deba@190
  1371
      _edges_caption = other._edges_caption;
deba@190
  1372
      _attributes_caption = other._attributes_caption;
deba@190
  1373
deba@190
  1374
    }
deba@190
  1375
deba@165
  1376
    GraphReader& operator=(const GraphReader&);
deba@165
  1377
deba@165
  1378
  public:
deba@165
  1379
deba@165
  1380
    /// \name Reading rules
deba@165
  1381
    /// @{
alpar@209
  1382
deba@165
  1383
    /// \brief Node map reading rule
deba@165
  1384
    ///
deba@165
  1385
    /// Add a node map reading rule to the reader.
deba@165
  1386
    template <typename Map>
deba@165
  1387
    GraphReader& nodeMap(const std::string& caption, Map& map) {
deba@165
  1388
      checkConcept<concepts::WriteMap<Node, typename Map::Value>, Map>();
alpar@209
  1389
      _reader_bits::MapStorageBase<Node>* storage =
alpar@209
  1390
        new _reader_bits::MapStorage<Node, Map>(map);
deba@165
  1391
      _node_maps.push_back(std::make_pair(caption, storage));
deba@165
  1392
      return *this;
deba@165
  1393
    }
deba@165
  1394
deba@165
  1395
    /// \brief Node map reading rule
deba@165
  1396
    ///
deba@165
  1397
    /// Add a node map reading rule with specialized converter to the
deba@165
  1398
    /// reader.
deba@165
  1399
    template <typename Map, typename Converter>
alpar@209
  1400
    GraphReader& nodeMap(const std::string& caption, Map& map,
alpar@209
  1401
                           const Converter& converter = Converter()) {
deba@165
  1402
      checkConcept<concepts::WriteMap<Node, typename Map::Value>, Map>();
alpar@209
  1403
      _reader_bits::MapStorageBase<Node>* storage =
alpar@209
  1404
        new _reader_bits::MapStorage<Node, Map, Converter>(map, converter);
deba@165
  1405
      _node_maps.push_back(std::make_pair(caption, storage));
deba@165
  1406
      return *this;
deba@165
  1407
    }
deba@165
  1408
deba@165
  1409
    /// \brief Edge map reading rule
deba@165
  1410
    ///
deba@165
  1411
    /// Add an edge map reading rule to the reader.
deba@165
  1412
    template <typename Map>
deba@165
  1413
    GraphReader& edgeMap(const std::string& caption, Map& map) {
deba@165
  1414
      checkConcept<concepts::WriteMap<Edge, typename Map::Value>, Map>();
alpar@209
  1415
      _reader_bits::MapStorageBase<Edge>* storage =
alpar@209
  1416
        new _reader_bits::MapStorage<Edge, Map>(map);
deba@165
  1417
      _edge_maps.push_back(std::make_pair(caption, storage));
deba@165
  1418
      return *this;
deba@165
  1419
    }
deba@165
  1420
deba@165
  1421
    /// \brief Edge map reading rule
deba@165
  1422
    ///
deba@165
  1423
    /// Add an edge map reading rule with specialized converter to the
deba@165
  1424
    /// reader.
deba@165
  1425
    template <typename Map, typename Converter>
alpar@209
  1426
    GraphReader& edgeMap(const std::string& caption, Map& map,
alpar@209
  1427
                          const Converter& converter = Converter()) {
deba@165
  1428
      checkConcept<concepts::WriteMap<Edge, typename Map::Value>, Map>();
alpar@209
  1429
      _reader_bits::MapStorageBase<Edge>* storage =
alpar@209
  1430
        new _reader_bits::MapStorage<Edge, Map, Converter>(map, converter);
deba@165
  1431
      _edge_maps.push_back(std::make_pair(caption, storage));
deba@165
  1432
      return *this;
deba@165
  1433
    }
deba@165
  1434
deba@165
  1435
    /// \brief Arc map reading rule
deba@165
  1436
    ///
deba@165
  1437
    /// Add an arc map reading rule to the reader.
deba@165
  1438
    template <typename Map>
deba@165
  1439
    GraphReader& arcMap(const std::string& caption, Map& map) {
deba@165
  1440
      checkConcept<concepts::WriteMap<Arc, typename Map::Value>, Map>();
alpar@209
  1441
      _reader_bits::MapStorageBase<Edge>* forward_storage =
alpar@209
  1442
        new _reader_bits::GraphArcMapStorage<Graph, true, Map>(_graph, map);
deba@165
  1443
      _edge_maps.push_back(std::make_pair('+' + caption, forward_storage));
alpar@209
  1444
      _reader_bits::MapStorageBase<Edge>* backward_storage =
alpar@209
  1445
        new _reader_bits::GraphArcMapStorage<Graph, false, Map>(_graph, map);
deba@165
  1446
      _edge_maps.push_back(std::make_pair('-' + caption, backward_storage));
deba@165
  1447
      return *this;
deba@165
  1448
    }
deba@165
  1449
deba@165
  1450
    /// \brief Arc map reading rule
deba@165
  1451
    ///
deba@165
  1452
    /// Add an arc map reading rule with specialized converter to the
deba@165
  1453
    /// reader.
deba@165
  1454
    template <typename Map, typename Converter>
alpar@209
  1455
    GraphReader& arcMap(const std::string& caption, Map& map,
alpar@209
  1456
                          const Converter& converter = Converter()) {
deba@165
  1457
      checkConcept<concepts::WriteMap<Arc, typename Map::Value>, Map>();
alpar@209
  1458
      _reader_bits::MapStorageBase<Edge>* forward_storage =
alpar@209
  1459
        new _reader_bits::GraphArcMapStorage<Graph, true, Map, Converter>
alpar@209
  1460
        (_graph, map, converter);
deba@165
  1461
      _edge_maps.push_back(std::make_pair('+' + caption, forward_storage));
alpar@209
  1462
      _reader_bits::MapStorageBase<Edge>* backward_storage =
alpar@209
  1463
        new _reader_bits::GraphArcMapStorage<Graph, false, Map, Converter>
alpar@209
  1464
        (_graph, map, converter);
deba@165
  1465
      _edge_maps.push_back(std::make_pair('-' + caption, backward_storage));
deba@165
  1466
      return *this;
deba@165
  1467
    }
deba@165
  1468
deba@165
  1469
    /// \brief Attribute reading rule
deba@165
  1470
    ///
deba@165
  1471
    /// Add an attribute reading rule to the reader.
deba@165
  1472
    template <typename Value>
deba@165
  1473
    GraphReader& attribute(const std::string& caption, Value& value) {
alpar@209
  1474
      _reader_bits::ValueStorageBase* storage =
alpar@209
  1475
        new _reader_bits::ValueStorage<Value>(value);
deba@165
  1476
      _attributes.insert(std::make_pair(caption, storage));
deba@165
  1477
      return *this;
deba@165
  1478
    }
deba@165
  1479
deba@165
  1480
    /// \brief Attribute reading rule
deba@165
  1481
    ///
deba@165
  1482
    /// Add an attribute reading rule with specialized converter to the
deba@165
  1483
    /// reader.
deba@165
  1484
    template <typename Value, typename Converter>
alpar@209
  1485
    GraphReader& attribute(const std::string& caption, Value& value,
alpar@209
  1486
                             const Converter& converter = Converter()) {
alpar@209
  1487
      _reader_bits::ValueStorageBase* storage =
alpar@209
  1488
        new _reader_bits::ValueStorage<Value, Converter>(value, converter);
deba@165
  1489
      _attributes.insert(std::make_pair(caption, storage));
deba@165
  1490
      return *this;
deba@165
  1491
    }
deba@165
  1492
deba@165
  1493
    /// \brief Node reading rule
deba@165
  1494
    ///
deba@165
  1495
    /// Add a node reading rule to reader.
deba@165
  1496
    GraphReader& node(const std::string& caption, Node& node) {
deba@165
  1497
      typedef _reader_bits::MapLookUpConverter<Node> Converter;
deba@165
  1498
      Converter converter(_node_index);
alpar@209
  1499
      _reader_bits::ValueStorageBase* storage =
alpar@209
  1500
        new _reader_bits::ValueStorage<Node, Converter>(node, converter);
deba@165
  1501
      _attributes.insert(std::make_pair(caption, storage));
deba@165
  1502
      return *this;
deba@165
  1503
    }
deba@165
  1504
deba@165
  1505
    /// \brief Edge reading rule
deba@165
  1506
    ///
deba@165
  1507
    /// Add an edge reading rule to reader.
deba@165
  1508
    GraphReader& edge(const std::string& caption, Edge& edge) {
deba@165
  1509
      typedef _reader_bits::MapLookUpConverter<Edge> Converter;
deba@165
  1510
      Converter converter(_edge_index);
alpar@209
  1511
      _reader_bits::ValueStorageBase* storage =
alpar@209
  1512
        new _reader_bits::ValueStorage<Edge, Converter>(edge, converter);
deba@165
  1513
      _attributes.insert(std::make_pair(caption, storage));
deba@165
  1514
      return *this;
deba@165
  1515
    }
deba@165
  1516
deba@165
  1517
    /// \brief Arc reading rule
deba@165
  1518
    ///
deba@165
  1519
    /// Add an arc reading rule to reader.
deba@165
  1520
    GraphReader& arc(const std::string& caption, Arc& arc) {
deba@165
  1521
      typedef _reader_bits::GraphArcLookUpConverter<Graph> Converter;
deba@165
  1522
      Converter converter(_graph, _edge_index);
alpar@209
  1523
      _reader_bits::ValueStorageBase* storage =
alpar@209
  1524
        new _reader_bits::ValueStorage<Arc, Converter>(arc, converter);
deba@165
  1525
      _attributes.insert(std::make_pair(caption, storage));
deba@165
  1526
      return *this;
deba@165
  1527
    }
deba@165
  1528
deba@165
  1529
    /// @}
deba@165
  1530
deba@165
  1531
    /// \name Select section by name
deba@165
  1532
    /// @{
deba@165
  1533
deba@165
  1534
    /// \brief Set \c \@nodes section to be read
deba@165
  1535
    ///
kpeter@192
  1536
    /// Set \c \@nodes section to be read.
deba@165
  1537
    GraphReader& nodes(const std::string& caption) {
deba@165
  1538
      _nodes_caption = caption;
deba@165
  1539
      return *this;
deba@165
  1540
    }
deba@165
  1541
deba@165
  1542
    /// \brief Set \c \@edges section to be read
deba@165
  1543
    ///
kpeter@192
  1544
    /// Set \c \@edges section to be read.
deba@165
  1545
    GraphReader& edges(const std::string& caption) {
deba@165
  1546
      _edges_caption = caption;
deba@165
  1547
      return *this;
deba@165
  1548
    }
deba@165
  1549
deba@165
  1550
    /// \brief Set \c \@attributes section to be read
deba@165
  1551
    ///
kpeter@192
  1552
    /// Set \c \@attributes section to be read.
deba@165
  1553
    GraphReader& attributes(const std::string& caption) {
deba@165
  1554
      _attributes_caption = caption;
deba@165
  1555
      return *this;
deba@165
  1556
    }
deba@165
  1557
deba@165
  1558
    /// @}
deba@165
  1559
deba@165
  1560
    /// \name Using previously constructed node or edge set
deba@165
  1561
    /// @{
deba@165
  1562
deba@165
  1563
    /// \brief Use previously constructed node set
deba@165
  1564
    ///
deba@165
  1565
    /// Use previously constructed node set, and specify the node
deba@165
  1566
    /// label map.
deba@165
  1567
    template <typename Map>
deba@165
  1568
    GraphReader& useNodes(const Map& map) {
deba@165
  1569
      checkConcept<concepts::ReadMap<Node, typename Map::Value>, Map>();
alpar@209
  1570
      LEMON_ASSERT(!_use_nodes, "Multiple usage of useNodes() member");
deba@165
  1571
      _use_nodes = true;
deba@165
  1572
      _writer_bits::DefaultConverter<typename Map::Value> converter;
deba@165
  1573
      for (NodeIt n(_graph); n != INVALID; ++n) {
alpar@209
  1574
        _node_index.insert(std::make_pair(converter(map[n]), n));
deba@165
  1575
      }
deba@165
  1576
      return *this;
deba@165
  1577
    }
deba@165
  1578
deba@165
  1579
    /// \brief Use previously constructed node set
deba@165
  1580
    ///
deba@165
  1581
    /// Use previously constructed node set, and specify the node
deba@165
  1582
    /// label map and a functor which converts the label map values to
kpeter@192
  1583
    /// \c std::string.
deba@165
  1584
    template <typename Map, typename Converter>
alpar@209
  1585
    GraphReader& useNodes(const Map& map,
alpar@209
  1586
                            const Converter& converter = Converter()) {
deba@165
  1587
      checkConcept<concepts::ReadMap<Node, typename Map::Value>, Map>();
alpar@209
  1588
      LEMON_ASSERT(!_use_nodes, "Multiple usage of useNodes() member");
deba@165
  1589
      _use_nodes = true;
deba@165
  1590
      for (NodeIt n(_graph); n != INVALID; ++n) {
alpar@209
  1591
        _node_index.insert(std::make_pair(converter(map[n]), n));
deba@165
  1592
      }
deba@165
  1593
      return *this;
deba@165
  1594
    }
deba@165
  1595
deba@165
  1596
    /// \brief Use previously constructed edge set
deba@165
  1597
    ///
deba@165
  1598
    /// Use previously constructed edge set, and specify the edge
deba@165
  1599
    /// label map.
deba@165
  1600
    template <typename Map>
deba@165
  1601
    GraphReader& useEdges(const Map& map) {
deba@165
  1602
      checkConcept<concepts::ReadMap<Edge, typename Map::Value>, Map>();
deba@165
  1603
      LEMON_ASSERT(!_use_edges, "Multiple usage of useEdges() member");
deba@165
  1604
      _use_edges = true;
deba@165
  1605
      _writer_bits::DefaultConverter<typename Map::Value> converter;
deba@165
  1606
      for (EdgeIt a(_graph); a != INVALID; ++a) {
alpar@209
  1607
        _edge_index.insert(std::make_pair(converter(map[a]), a));
deba@165
  1608
      }
deba@165
  1609
      return *this;
deba@165
  1610
    }
deba@165
  1611
deba@165
  1612
    /// \brief Use previously constructed edge set
deba@165
  1613
    ///
deba@165
  1614
    /// Use previously constructed edge set, and specify the edge
deba@165
  1615
    /// label map and a functor which converts the label map values to
kpeter@192
  1616
    /// \c std::string.
deba@165
  1617
    template <typename Map, typename Converter>
alpar@209
  1618
    GraphReader& useEdges(const Map& map,
alpar@209
  1619
                            const Converter& converter = Converter()) {
deba@165
  1620
      checkConcept<concepts::ReadMap<Edge, typename Map::Value>, Map>();
alpar@209
  1621
      LEMON_ASSERT(!_use_edges, "Multiple usage of useEdges() member");
deba@165
  1622
      _use_edges = true;
deba@165
  1623
      for (EdgeIt a(_graph); a != INVALID; ++a) {
alpar@209
  1624
        _edge_index.insert(std::make_pair(converter(map[a]), a));
deba@165
  1625
      }
deba@165
  1626
      return *this;
deba@165
  1627
    }
deba@165
  1628
kpeter@192
  1629
    /// \brief Skip the reading of node section
deba@188
  1630
    ///
deba@188
  1631
    /// Omit the reading of the node section. This implies that each node
kpeter@192
  1632
    /// map reading rule will be abandoned, and the nodes of the graph
deba@188
  1633
    /// will not be constructed, which usually cause that the edge set
deba@188
  1634
    /// could not be read due to lack of node name
kpeter@192
  1635
    /// could not be read due to lack of node name resolving.
kpeter@192
  1636
    /// Therefore \c skipEdges() function should also be used, or
kpeter@192
  1637
    /// \c useNodes() should be used to specify the label of the nodes.
deba@188
  1638
    GraphReader& skipNodes() {
alpar@209
  1639
      LEMON_ASSERT(!_skip_nodes, "Skip nodes already set");
deba@188
  1640
      _skip_nodes = true;
deba@188
  1641
      return *this;
deba@188
  1642
    }
deba@188
  1643
kpeter@192
  1644
    /// \brief Skip the reading of edge section
deba@188
  1645
    ///
deba@188
  1646
    /// Omit the reading of the edge section. This implies that each edge
kpeter@192
  1647
    /// map reading rule will be abandoned, and the edges of the graph
deba@188
  1648
    /// will not be constructed.
deba@188
  1649
    GraphReader& skipEdges() {
alpar@209
  1650
      LEMON_ASSERT(!_skip_edges, "Skip edges already set");
deba@188
  1651
      _skip_edges = true;
deba@188
  1652
      return *this;
deba@188
  1653
    }
deba@188
  1654
deba@165
  1655
    /// @}
deba@165
  1656
deba@165
  1657
  private:
deba@165
  1658
deba@165
  1659
    bool readLine() {
deba@165
  1660
      std::string str;
deba@165
  1661
      while(++line_num, std::getline(*_is, str)) {
alpar@209
  1662
        line.clear(); line.str(str);
alpar@209
  1663
        char c;
alpar@209
  1664
        if (line >> std::ws >> c && c != '#') {
alpar@209
  1665
          line.putback(c);
alpar@209
  1666
          return true;
alpar@209
  1667
        }
deba@165
  1668
      }
deba@165
  1669
      return false;
deba@165
  1670
    }
deba@165
  1671
deba@165
  1672
    bool readSuccess() {
deba@165
  1673
      return static_cast<bool>(*_is);
deba@165
  1674
    }
alpar@209
  1675
deba@165
  1676
    void skipSection() {
deba@165
  1677
      char c;
deba@165
  1678
      while (readSuccess() && line >> c && c != '@') {
alpar@209
  1679
        readLine();
deba@165
  1680
      }
deba@165
  1681
      line.putback(c);
deba@165
  1682
    }
deba@165
  1683
deba@165
  1684
    void readNodes() {
deba@165
  1685
deba@165
  1686
      std::vector<int> map_index(_node_maps.size());
deba@165
  1687
      int map_num, label_index;
deba@165
  1688
deba@186
  1689
      char c;
deba@186
  1690
      if (!readLine() || !(line >> c) || c == '@') {
alpar@209
  1691
        if (readSuccess() && line) line.putback(c);
alpar@209
  1692
        if (!_node_maps.empty())
deba@290
  1693
          throw FormatError("Cannot find map names");
alpar@209
  1694
        return;
deba@186
  1695
      }
deba@186
  1696
      line.putback(c);
alpar@209
  1697
deba@165
  1698
      {
alpar@209
  1699
        std::map<std::string, int> maps;
alpar@209
  1700
alpar@209
  1701
        std::string map;
alpar@209
  1702
        int index = 0;
alpar@209
  1703
        while (_reader_bits::readToken(line, map)) {
alpar@209
  1704
          if (maps.find(map) != maps.end()) {
alpar@209
  1705
            std::ostringstream msg;
alpar@209
  1706
            msg << "Multiple occurence of node map: " << map;
deba@290
  1707
            throw FormatError(msg.str());
alpar@209
  1708
          }
alpar@209
  1709
          maps.insert(std::make_pair(map, index));
alpar@209
  1710
          ++index;
alpar@209
  1711
        }
alpar@209
  1712
alpar@209
  1713
        for (int i = 0; i < static_cast<int>(_node_maps.size()); ++i) {
alpar@209
  1714
          std::map<std::string, int>::iterator jt =
alpar@209
  1715
            maps.find(_node_maps[i].first);
alpar@209
  1716
          if (jt == maps.end()) {
alpar@209
  1717
            std::ostringstream msg;
alpar@209
  1718
            msg << "Map not found in file: " << _node_maps[i].first;
deba@290
  1719
            throw FormatError(msg.str());
alpar@209
  1720
          }
alpar@209
  1721
          map_index[i] = jt->second;
alpar@209
  1722
        }
alpar@209
  1723
alpar@209
  1724
        {
alpar@209
  1725
          std::map<std::string, int>::iterator jt = maps.find("label");
alpar@209
  1726
          if (jt != maps.end()) {
alpar@209
  1727
            label_index = jt->second;
alpar@209
  1728
          } else {
alpar@209
  1729
            label_index = -1;
alpar@209
  1730
          }
alpar@209
  1731
        }
alpar@209
  1732
        map_num = maps.size();
deba@165
  1733
      }
deba@165
  1734
deba@165
  1735
      while (readLine() && line >> c && c != '@') {
alpar@209
  1736
        line.putback(c);
alpar@209
  1737
alpar@209
  1738
        std::vector<std::string> tokens(map_num);
alpar@209
  1739
        for (int i = 0; i < map_num; ++i) {
alpar@209
  1740
          if (!_reader_bits::readToken(line, tokens[i])) {
alpar@209
  1741
            std::ostringstream msg;
alpar@209
  1742
            msg << "Column not found (" << i + 1 << ")";
deba@290
  1743
            throw FormatError(msg.str());
alpar@209
  1744
          }
alpar@209
  1745
        }
alpar@209
  1746
        if (line >> std::ws >> c)
deba@290
  1747
          throw FormatError("Extra character on the end of line");
alpar@209
  1748
alpar@209
  1749
        Node n;
alpar@209
  1750
        if (!_use_nodes) {
alpar@209
  1751
          n = _graph.addNode();
alpar@209
  1752
          if (label_index != -1)
alpar@209
  1753
            _node_index.insert(std::make_pair(tokens[label_index], n));
alpar@209
  1754
        } else {
alpar@209
  1755
          if (label_index == -1)
deba@290
  1756
            throw FormatError("Label map not found in file");
alpar@209
  1757
          typename std::map<std::string, Node>::iterator it =
alpar@209
  1758
            _node_index.find(tokens[label_index]);
alpar@209
  1759
          if (it == _node_index.end()) {
alpar@209
  1760
            std::ostringstream msg;
alpar@209
  1761
            msg << "Node with label not found: " << tokens[label_index];
deba@290
  1762
            throw FormatError(msg.str());
alpar@209
  1763
          }
alpar@209
  1764
          n = it->second;
alpar@209
  1765
        }
alpar@209
  1766
alpar@209
  1767
        for (int i = 0; i < static_cast<int>(_node_maps.size()); ++i) {
alpar@209
  1768
          _node_maps[i].second->set(n, tokens[map_index[i]]);
alpar@209
  1769
        }
deba@165
  1770
deba@165
  1771
      }
deba@165
  1772
      if (readSuccess()) {
alpar@209
  1773
        line.putback(c);
deba@165
  1774
      }
deba@165
  1775
    }
deba@165
  1776
deba@165
  1777
    void readEdges() {
deba@165
  1778
deba@165
  1779
      std::vector<int> map_index(_edge_maps.size());
deba@165
  1780
      int map_num, label_index;
deba@165
  1781
deba@186
  1782
      char c;
deba@186
  1783
      if (!readLine() || !(line >> c) || c == '@') {
alpar@209
  1784
        if (readSuccess() && line) line.putback(c);
alpar@209
  1785
        if (!_edge_maps.empty())
deba@290
  1786
          throw FormatError("Cannot find map names");
alpar@209
  1787
        return;
deba@186
  1788
      }
deba@186
  1789
      line.putback(c);
alpar@209
  1790
deba@165
  1791
      {
alpar@209
  1792
        std::map<std::string, int> maps;
alpar@209
  1793
alpar@209
  1794
        std::string map;
alpar@209
  1795
        int index = 0;
alpar@209
  1796
        while (_reader_bits::readToken(line, map)) {
alpar@209
  1797
          if (maps.find(map) != maps.end()) {
alpar@209
  1798
            std::ostringstream msg;
alpar@209
  1799
            msg << "Multiple occurence of edge map: " << map;
deba@290
  1800
            throw FormatError(msg.str());
alpar@209
  1801
          }
alpar@209
  1802
          maps.insert(std::make_pair(map, index));
alpar@209
  1803
          ++index;
alpar@209
  1804
        }
alpar@209
  1805
alpar@209
  1806
        for (int i = 0; i < static_cast<int>(_edge_maps.size()); ++i) {
alpar@209
  1807
          std::map<std::string, int>::iterator jt =
alpar@209
  1808
            maps.find(_edge_maps[i].first);
alpar@209
  1809
          if (jt == maps.end()) {
alpar@209
  1810
            std::ostringstream msg;
alpar@209
  1811
            msg << "Map not found in file: " << _edge_maps[i].first;
deba@290
  1812
            throw FormatError(msg.str());
alpar@209
  1813
          }
alpar@209
  1814
          map_index[i] = jt->second;
alpar@209
  1815
        }
alpar@209
  1816
alpar@209
  1817
        {
alpar@209
  1818
          std::map<std::string, int>::iterator jt = maps.find("label");
alpar@209
  1819
          if (jt != maps.end()) {
alpar@209
  1820
            label_index = jt->second;
alpar@209
  1821
          } else {
alpar@209
  1822
            label_index = -1;
alpar@209
  1823
          }
alpar@209
  1824
        }
alpar@209
  1825
        map_num = maps.size();
deba@165
  1826
      }
deba@165
  1827
deba@165
  1828
      while (readLine() && line >> c && c != '@') {
alpar@209
  1829
        line.putback(c);
alpar@209
  1830
alpar@209
  1831
        std::string source_token;
alpar@209
  1832
        std::string target_token;
alpar@209
  1833
alpar@209
  1834
        if (!_reader_bits::readToken(line, source_token))
deba@290
  1835
          throw FormatError("Node u not found");
alpar@209
  1836
alpar@209
  1837
        if (!_reader_bits::readToken(line, target_token))
deba@290
  1838
          throw FormatError("Node v not found");
alpar@209
  1839
alpar@209
  1840
        std::vector<std::string> tokens(map_num);
alpar@209
  1841
        for (int i = 0; i < map_num; ++i) {
alpar@209
  1842
          if (!_reader_bits::readToken(line, tokens[i])) {
alpar@209
  1843
            std::ostringstream msg;
alpar@209
  1844
            msg << "Column not found (" << i + 1 << ")";
deba@290
  1845
            throw FormatError(msg.str());
alpar@209
  1846
          }
alpar@209
  1847
        }
alpar@209
  1848
        if (line >> std::ws >> c)
deba@290
  1849
          throw FormatError("Extra character on the end of line");
alpar@209
  1850
alpar@209
  1851
        Edge e;
alpar@209
  1852
        if (!_use_edges) {
deba@165
  1853
deba@165
  1854
          typename NodeIndex::iterator it;
alpar@209
  1855
deba@165
  1856
          it = _node_index.find(source_token);
deba@165
  1857
          if (it == _node_index.end()) {
deba@165
  1858
            std::ostringstream msg;
deba@165
  1859
            msg << "Item not found: " << source_token;
deba@290
  1860
            throw FormatError(msg.str());
deba@165
  1861
          }
deba@165
  1862
          Node source = it->second;
deba@165
  1863
deba@165
  1864
          it = _node_index.find(target_token);
alpar@209
  1865
          if (it == _node_index.end()) {
alpar@209
  1866
            std::ostringstream msg;
deba@165
  1867
            msg << "Item not found: " << target_token;
deba@290
  1868
            throw FormatError(msg.str());
alpar@209
  1869
          }
alpar@209
  1870
          Node target = it->second;
alpar@209
  1871
alpar@209
  1872
          e = _graph.addEdge(source, target);
alpar@209
  1873
          if (label_index != -1)
alpar@209
  1874
            _edge_index.insert(std::make_pair(tokens[label_index], e));
alpar@209
  1875
        } else {
alpar@209
  1876
          if (label_index == -1)
deba@290
  1877
            throw FormatError("Label map not found in file");
alpar@209
  1878
          typename std::map<std::string, Edge>::iterator it =
alpar@209
  1879
            _edge_index.find(tokens[label_index]);
alpar@209
  1880
          if (it == _edge_index.end()) {
alpar@209
  1881
            std::ostringstream msg;
alpar@209
  1882
            msg << "Edge with label not found: " << tokens[label_index];
deba@290
  1883
            throw FormatError(msg.str());
alpar@209
  1884
          }
alpar@209
  1885
          e = it->second;
alpar@209
  1886
        }
alpar@209
  1887
alpar@209
  1888
        for (int i = 0; i < static_cast<int>(_edge_maps.size()); ++i) {
alpar@209
  1889
          _edge_maps[i].second->set(e, tokens[map_index[i]]);
alpar@209
  1890
        }
deba@165
  1891
deba@165
  1892
      }
deba@165
  1893
      if (readSuccess()) {
alpar@209
  1894
        line.putback(c);
deba@165
  1895
      }
deba@165
  1896
    }
deba@165
  1897
deba@165
  1898
    void readAttributes() {
deba@165
  1899
deba@165
  1900
      std::set<std::string> read_attr;
deba@165
  1901
deba@165
  1902
      char c;
deba@165
  1903
      while (readLine() && line >> c && c != '@') {
alpar@209
  1904
        line.putback(c);
alpar@209
  1905
alpar@209
  1906
        std::string attr, token;
alpar@209
  1907
        if (!_reader_bits::readToken(line, attr))
deba@290
  1908
          throw FormatError("Attribute name not found");
alpar@209
  1909
        if (!_reader_bits::readToken(line, token))
deba@290
  1910
          throw FormatError("Attribute value not found");
alpar@209
  1911
        if (line >> c)
deba@290
  1912
          throw FormatError("Extra character on the end of line");
alpar@209
  1913
alpar@209
  1914
        {
alpar@209
  1915
          std::set<std::string>::iterator it = read_attr.find(attr);
alpar@209
  1916
          if (it != read_attr.end()) {
alpar@209
  1917
            std::ostringstream msg;
alpar@209
  1918
            msg << "Multiple occurence of attribute " << attr;
deba@290
  1919
            throw FormatError(msg.str());
alpar@209
  1920
          }
alpar@209
  1921
          read_attr.insert(attr);
alpar@209
  1922
        }
alpar@209
  1923
alpar@209
  1924
        {
alpar@209
  1925
          typename Attributes::iterator it = _attributes.lower_bound(attr);
alpar@209
  1926
          while (it != _attributes.end() && it->first == attr) {
alpar@209
  1927
            it->second->set(token);
alpar@209
  1928
            ++it;
alpar@209
  1929
          }
alpar@209
  1930
        }
deba@165
  1931
deba@165
  1932
      }
deba@165
  1933
      if (readSuccess()) {
alpar@209
  1934
        line.putback(c);
deba@165
  1935
      }
deba@165
  1936
      for (typename Attributes::iterator it = _attributes.begin();
alpar@209
  1937
           it != _attributes.end(); ++it) {
alpar@209
  1938
        if (read_attr.find(it->first) == read_attr.end()) {
alpar@209
  1939
          std::ostringstream msg;
alpar@209
  1940
          msg << "Attribute not found in file: " << it->first;
deba@290
  1941
          throw FormatError(msg.str());
alpar@209
  1942
        }
deba@165
  1943
      }
deba@165
  1944
    }
deba@165
  1945
deba@165
  1946
  public:
deba@165
  1947
alpar@209
  1948
    /// \name Execution of the reader
deba@165
  1949
    /// @{
deba@165
  1950
deba@165
  1951
    /// \brief Start the batch processing
deba@165
  1952
    ///
deba@165
  1953
    /// This function starts the batch processing
deba@165
  1954
    void run() {
alpar@209
  1955
deba@165
  1956
      LEMON_ASSERT(_is != 0, "This reader assigned to an other reader");
alpar@209
  1957
deba@188
  1958
      bool nodes_done = _skip_nodes;
deba@188
  1959
      bool edges_done = _skip_edges;
deba@165
  1960
      bool attributes_done = false;
deba@165
  1961
alpar@209
  1962
      line_num = 0;
deba@165
  1963
      readLine();
deba@172
  1964
      skipSection();
deba@165
  1965
deba@165
  1966
      while (readSuccess()) {
alpar@209
  1967
        try {
alpar@209
  1968
          char c;
alpar@209
  1969
          std::string section, caption;
alpar@209
  1970
          line >> c;
alpar@209
  1971
          _reader_bits::readToken(line, section);
alpar@209
  1972
          _reader_bits::readToken(line, caption);
alpar@209
  1973
alpar@209
  1974
          if (line >> c)
deba@290
  1975
            throw FormatError("Extra character on the end of line");
alpar@209
  1976
alpar@209
  1977
          if (section == "nodes" && !nodes_done) {
alpar@209
  1978
            if (_nodes_caption.empty() || _nodes_caption == caption) {
alpar@209
  1979
              readNodes();
alpar@209
  1980
              nodes_done = true;
alpar@209
  1981
            }
alpar@209
  1982
          } else if ((section == "edges" || section == "arcs") &&
alpar@209
  1983
                     !edges_done) {
alpar@209
  1984
            if (_edges_caption.empty() || _edges_caption == caption) {
alpar@209
  1985
              readEdges();
alpar@209
  1986
              edges_done = true;
alpar@209
  1987
            }
alpar@209
  1988
          } else if (section == "attributes" && !attributes_done) {
alpar@209
  1989
            if (_attributes_caption.empty() || _attributes_caption == caption) {
alpar@209
  1990
              readAttributes();
alpar@209
  1991
              attributes_done = true;
alpar@209
  1992
            }
alpar@209
  1993
          } else {
alpar@209
  1994
            readLine();
alpar@209
  1995
            skipSection();
alpar@209
  1996
          }
deba@290
  1997
        } catch (FormatError& error) {
alpar@209
  1998
          error.line(line_num);
deba@290
  1999
          error.file(_filename);
alpar@209
  2000
          throw;
alpar@209
  2001
        }
deba@165
  2002
      }
deba@165
  2003
deba@165
  2004
      if (!nodes_done) {
deba@290
  2005
        throw FormatError("Section @nodes not found");
deba@165
  2006
      }
deba@165
  2007
deba@165
  2008
      if (!edges_done) {
deba@290
  2009
        throw FormatError("Section @edges not found");
deba@165
  2010
      }
deba@165
  2011
deba@165
  2012
      if (!attributes_done && !_attributes.empty()) {
deba@290
  2013
        throw FormatError("Section @attributes not found");
deba@165
  2014
      }
deba@165
  2015
deba@165
  2016
    }
deba@165
  2017
deba@165
  2018
    /// @}
alpar@209
  2019
deba@165
  2020
  };
deba@165
  2021
kpeter@192
  2022
  /// \brief Return a \ref GraphReader class
alpar@209
  2023
  ///
kpeter@192
  2024
  /// This function just returns a \ref GraphReader class.
deba@165
  2025
  /// \relates GraphReader
deba@165
  2026
  template <typename Graph>
deba@165
  2027
  GraphReader<Graph> graphReader(std::istream& is, Graph& graph) {
deba@165
  2028
    GraphReader<Graph> tmp(is, graph);
deba@165
  2029
    return tmp;
deba@165
  2030
  }
deba@165
  2031
kpeter@192
  2032
  /// \brief Return a \ref GraphReader class
alpar@209
  2033
  ///
kpeter@192
  2034
  /// This function just returns a \ref GraphReader class.
deba@165
  2035
  /// \relates GraphReader
deba@165
  2036
  template <typename Graph>
alpar@209
  2037
  GraphReader<Graph> graphReader(const std::string& fn,
alpar@209
  2038
                                       Graph& graph) {
deba@165
  2039
    GraphReader<Graph> tmp(fn, graph);
deba@165
  2040
    return tmp;
deba@165
  2041
  }
deba@165
  2042
kpeter@192
  2043
  /// \brief Return a \ref GraphReader class
alpar@209
  2044
  ///
kpeter@192
  2045
  /// This function just returns a \ref GraphReader class.
deba@165
  2046
  /// \relates GraphReader
deba@165
  2047
  template <typename Graph>
deba@165
  2048
  GraphReader<Graph> graphReader(const char* fn, Graph& graph) {
deba@165
  2049
    GraphReader<Graph> tmp(fn, graph);
deba@165
  2050
    return tmp;
deba@165
  2051
  }
deba@173
  2052
deba@190
  2053
  class SectionReader;
deba@190
  2054
deba@190
  2055
  SectionReader sectionReader(std::istream& is);
deba@190
  2056
  SectionReader sectionReader(const std::string& fn);
deba@190
  2057
  SectionReader sectionReader(const char* fn);
alpar@209
  2058
kpeter@192
  2059
  /// \ingroup lemon_io
kpeter@192
  2060
  ///
deba@189
  2061
  /// \brief Section reader class
deba@189
  2062
  ///
alpar@209
  2063
  /// In the \ref lgf-format "LGF" file extra sections can be placed,
kpeter@192
  2064
  /// which contain any data in arbitrary format. Such sections can be
alpar@209
  2065
  /// read with this class. A reading rule can be added to the class
kpeter@192
  2066
  /// with two different functions. With the \c sectionLines() function a
kpeter@192
  2067
  /// functor can process the section line-by-line, while with the \c
deba@189
  2068
  /// sectionStream() member the section can be read from an input
deba@189
  2069
  /// stream.
deba@189
  2070
  class SectionReader {
deba@189
  2071
  private:
alpar@209
  2072
deba@189
  2073
    std::istream* _is;
deba@189
  2074
    bool local_is;
deba@290
  2075
    std::string _filename;
deba@189
  2076
deba@189
  2077
    typedef std::map<std::string, _reader_bits::Section*> Sections;
deba@189
  2078
    Sections _sections;
deba@189
  2079
deba@189
  2080
    int line_num;
deba@189
  2081
    std::istringstream line;
deba@189
  2082
deba@189
  2083
  public:
deba@189
  2084
deba@189
  2085
    /// \brief Constructor
deba@189
  2086
    ///
deba@189
  2087
    /// Construct a section reader, which reads from the given input
deba@189
  2088
    /// stream.
alpar@209
  2089
    SectionReader(std::istream& is)
deba@189
  2090
      : _is(&is), local_is(false) {}
deba@189
  2091
deba@189
  2092
    /// \brief Constructor
deba@189
  2093
    ///
deba@189
  2094
    /// Construct a section reader, which reads from the given file.
alpar@209
  2095
    SectionReader(const std::string& fn)
deba@290
  2096
      : _is(new std::ifstream(fn.c_str())), local_is(true),
deba@290
  2097
        _filename(fn) {
deba@290
  2098
      if (!(*_is)) throw IoError(fn, "Cannot open file");
deba@290
  2099
    }
alpar@209
  2100
deba@189
  2101
    /// \brief Constructor
deba@189
  2102
    ///
deba@189
  2103
    /// Construct a section reader, which reads from the given file.
alpar@209
  2104
    SectionReader(const char* fn)
deba@290
  2105
      : _is(new std::ifstream(fn)), local_is(true),
deba@290
  2106
        _filename(fn) {
deba@290
  2107
      if (!(*_is)) throw IoError(fn, "Cannot open file");
deba@290
  2108
    }
deba@189
  2109
deba@189
  2110
    /// \brief Destructor
deba@189
  2111
    ~SectionReader() {
alpar@209
  2112
      for (Sections::iterator it = _sections.begin();
alpar@209
  2113
           it != _sections.end(); ++it) {
alpar@209
  2114
        delete it->second;
deba@189
  2115
      }
deba@189
  2116
deba@189
  2117
      if (local_is) {
alpar@209
  2118
        delete _is;
deba@189
  2119
      }
deba@189
  2120
deba@189
  2121
    }
deba@189
  2122
deba@189
  2123
  private:
deba@190
  2124
deba@190
  2125
    friend SectionReader sectionReader(std::istream& is);
deba@190
  2126
    friend SectionReader sectionReader(const std::string& fn);
deba@190
  2127
    friend SectionReader sectionReader(const char* fn);
deba@190
  2128
alpar@209
  2129
    SectionReader(SectionReader& other)
deba@190
  2130
      : _is(other._is), local_is(other.local_is) {
deba@190
  2131
deba@190
  2132
      other._is = 0;
deba@190
  2133
      other.local_is = false;
alpar@209
  2134
deba@190
  2135
      _sections.swap(other._sections);
deba@190
  2136
    }
alpar@209
  2137
deba@189
  2138
    SectionReader& operator=(const SectionReader&);
deba@189
  2139
deba@189
  2140
  public:
deba@189
  2141
deba@189
  2142
    /// \name Section readers
deba@189
  2143
    /// @{
deba@189
  2144
deba@189
  2145
    /// \brief Add a section processor with line oriented reading
deba@189
  2146
    ///
deba@189
  2147
    /// The first parameter is the type descriptor of the section, the
deba@189
  2148
    /// second is a functor, which takes just one \c std::string
deba@189
  2149
    /// parameter. At the reading process, each line of the section
deba@189
  2150
    /// will be given to the functor object. However, the empty lines
deba@189
  2151
    /// and the comment lines are filtered out, and the leading
deba@189
  2152
    /// whitespaces are trimmed from each processed string.
deba@189
  2153
    ///
deba@189
  2154
    /// For example let's see a section, which contain several
deba@189
  2155
    /// integers, which should be inserted into a vector.
deba@189
  2156
    ///\code
deba@189
  2157
    ///  @numbers
deba@189
  2158
    ///  12 45 23
deba@189
  2159
    ///  4
deba@189
  2160
    ///  23 6
deba@189
  2161
    ///\endcode
deba@189
  2162
    ///
kpeter@192
  2163
    /// The functor is implemented as a struct:
deba@189
  2164
    ///\code
deba@189
  2165
    ///  struct NumberSection {
deba@189
  2166
    ///    std::vector<int>& _data;
deba@189
  2167
    ///    NumberSection(std::vector<int>& data) : _data(data) {}
deba@189
  2168
    ///    void operator()(const std::string& line) {
deba@189
  2169
    ///      std::istringstream ls(line);
deba@189
  2170
    ///      int value;
deba@189
  2171
    ///      while (ls >> value) _data.push_back(value);
deba@189
  2172
    ///    }
deba@189
  2173
    ///  };
deba@189
  2174
    ///
deba@189
  2175
    ///  // ...
deba@189
  2176
    ///
alpar@209
  2177
    ///  reader.sectionLines("numbers", NumberSection(vec));
deba@189
  2178
    ///\endcode
deba@189
  2179
    template <typename Functor>
deba@189
  2180
    SectionReader& sectionLines(const std::string& type, Functor functor) {
kpeter@192
  2181
      LEMON_ASSERT(!type.empty(), "Type is empty.");
alpar@209
  2182
      LEMON_ASSERT(_sections.find(type) == _sections.end(),
alpar@209
  2183
                   "Multiple reading of section.");
alpar@209
  2184
      _sections.insert(std::make_pair(type,
deba@189
  2185
        new _reader_bits::LineSection<Functor>(functor)));
deba@189
  2186
      return *this;
deba@189
  2187
    }
deba@189
  2188
deba@189
  2189
deba@189
  2190
    /// \brief Add a section processor with stream oriented reading
deba@189
  2191
    ///
deba@189
  2192
    /// The first parameter is the type of the section, the second is
kpeter@192
  2193
    /// a functor, which takes an \c std::istream& and an \c int&
deba@189
  2194
    /// parameter, the latter regard to the line number of stream. The
deba@189
  2195
    /// functor can read the input while the section go on, and the
deba@189
  2196
    /// line number should be modified accordingly.
deba@189
  2197
    template <typename Functor>
deba@189
  2198
    SectionReader& sectionStream(const std::string& type, Functor functor) {
kpeter@192
  2199
      LEMON_ASSERT(!type.empty(), "Type is empty.");
alpar@209
  2200
      LEMON_ASSERT(_sections.find(type) == _sections.end(),
alpar@209
  2201
                   "Multiple reading of section.");
alpar@209
  2202
      _sections.insert(std::make_pair(type,
alpar@209
  2203
         new _reader_bits::StreamSection<Functor>(functor)));
deba@189
  2204
      return *this;
alpar@209
  2205
    }
alpar@209
  2206
deba@189
  2207
    /// @}
deba@189
  2208
deba@189
  2209
  private:
deba@189
  2210
deba@189
  2211
    bool readLine() {
deba@189
  2212
      std::string str;
deba@189
  2213
      while(++line_num, std::getline(*_is, str)) {
alpar@209
  2214
        line.clear(); line.str(str);
alpar@209
  2215
        char c;
alpar@209
  2216
        if (line >> std::ws >> c && c != '#') {
alpar@209
  2217
          line.putback(c);
alpar@209
  2218
          return true;
alpar@209
  2219
        }
deba@189
  2220
      }
deba@189
  2221
      return false;
deba@189
  2222
    }
deba@189
  2223
deba@189
  2224
    bool readSuccess() {
deba@189
  2225
      return static_cast<bool>(*_is);
deba@189
  2226
    }
alpar@209
  2227
deba@189
  2228
    void skipSection() {
deba@189
  2229
      char c;
deba@189
  2230
      while (readSuccess() && line >> c && c != '@') {
alpar@209
  2231
        readLine();
deba@189
  2232
      }
deba@189
  2233
      line.putback(c);
deba@189
  2234
    }
deba@189
  2235
deba@189
  2236
  public:
deba@189
  2237
deba@189
  2238
alpar@209
  2239
    /// \name Execution of the reader
deba@189
  2240
    /// @{
deba@189
  2241
deba@189
  2242
    /// \brief Start the batch processing
deba@189
  2243
    ///
kpeter@192
  2244
    /// This function starts the batch processing.
deba@189
  2245
    void run() {
alpar@209
  2246
deba@189
  2247
      LEMON_ASSERT(_is != 0, "This reader assigned to an other reader");
alpar@209
  2248
deba@189
  2249
      std::set<std::string> extra_sections;
deba@189
  2250
alpar@209
  2251
      line_num = 0;
deba@189
  2252
      readLine();
deba@189
  2253
      skipSection();
deba@189
  2254
deba@189
  2255
      while (readSuccess()) {
alpar@209
  2256
        try {
alpar@209
  2257
          char c;
alpar@209
  2258
          std::string section, caption;
alpar@209
  2259
          line >> c;
alpar@209
  2260
          _reader_bits::readToken(line, section);
alpar@209
  2261
          _reader_bits::readToken(line, caption);
alpar@209
  2262
alpar@209
  2263
          if (line >> c)
deba@290
  2264
            throw FormatError("Extra character on the end of line");
alpar@209
  2265
alpar@209
  2266
          if (extra_sections.find(section) != extra_sections.end()) {
alpar@209
  2267
            std::ostringstream msg;
alpar@209
  2268
            msg << "Multiple occurence of section " << section;
deba@290
  2269
            throw FormatError(msg.str());
alpar@209
  2270
          }
alpar@209
  2271
          Sections::iterator it = _sections.find(section);
alpar@209
  2272
          if (it != _sections.end()) {
alpar@209
  2273
            extra_sections.insert(section);
alpar@209
  2274
            it->second->process(*_is, line_num);
alpar@209
  2275
          }
alpar@209
  2276
          readLine();
alpar@209
  2277
          skipSection();
deba@290
  2278
        } catch (FormatError& error) {
alpar@209
  2279
          error.line(line_num);
deba@290
  2280
          error.file(_filename);
alpar@209
  2281
          throw;
alpar@209
  2282
        }
deba@189
  2283
      }
deba@189
  2284
      for (Sections::iterator it = _sections.begin();
alpar@209
  2285
           it != _sections.end(); ++it) {
alpar@209
  2286
        if (extra_sections.find(it->first) == extra_sections.end()) {
alpar@209
  2287
          std::ostringstream os;
alpar@209
  2288
          os << "Cannot find section: " << it->first;
deba@290
  2289
          throw FormatError(os.str());
alpar@209
  2290
        }
deba@189
  2291
      }
deba@189
  2292
    }
deba@189
  2293
deba@189
  2294
    /// @}
alpar@209
  2295
deba@189
  2296
  };
deba@189
  2297
kpeter@192
  2298
  /// \brief Return a \ref SectionReader class
alpar@209
  2299
  ///
kpeter@192
  2300
  /// This function just returns a \ref SectionReader class.
deba@189
  2301
  /// \relates SectionReader
deba@189
  2302
  inline SectionReader sectionReader(std::istream& is) {
deba@189
  2303
    SectionReader tmp(is);
deba@189
  2304
    return tmp;
deba@189
  2305
  }
deba@189
  2306
kpeter@192
  2307
  /// \brief Return a \ref SectionReader class
alpar@209
  2308
  ///
kpeter@192
  2309
  /// This function just returns a \ref SectionReader class.
deba@189
  2310
  /// \relates SectionReader
deba@189
  2311
  inline SectionReader sectionReader(const std::string& fn) {
deba@189
  2312
    SectionReader tmp(fn);
deba@189
  2313
    return tmp;
deba@189
  2314
  }
deba@189
  2315
kpeter@192
  2316
  /// \brief Return a \ref SectionReader class
alpar@209
  2317
  ///
kpeter@192
  2318
  /// This function just returns a \ref SectionReader class.
deba@189
  2319
  /// \relates SectionReader
deba@189
  2320
  inline SectionReader sectionReader(const char* fn) {
deba@189
  2321
    SectionReader tmp(fn);
deba@189
  2322
    return tmp;
deba@189
  2323
  }
deba@189
  2324
deba@173
  2325
  /// \ingroup lemon_io
deba@173
  2326
  ///
alpar@209
  2327
  /// \brief Reader for the contents of the \ref lgf-format "LGF" file
deba@173
  2328
  ///
deba@173
  2329
  /// This class can be used to read the sections, the map names and
ladanyi@236
  2330
  /// the attributes from a file. Usually, the LEMON programs know
deba@173
  2331
  /// that, which type of graph, which maps and which attributes
deba@173
  2332
  /// should be read from a file, but in general tools (like glemon)
alpar@179
  2333
  /// the contents of an LGF file should be guessed somehow. This class
deba@173
  2334
  /// reads the graph and stores the appropriate information for
deba@173
  2335
  /// reading the graph.
deba@173
  2336
  ///
alpar@209
  2337
  ///\code
alpar@209
  2338
  /// LgfContents contents("graph.lgf");
alpar@179
  2339
  /// contents.run();
deba@173
  2340
  ///
kpeter@192
  2341
  /// // Does it contain any node section and arc section?
alpar@179
  2342
  /// if (contents.nodeSectionNum() == 0 || contents.arcSectionNum()) {
kpeter@192
  2343
  ///   std::cerr << "Failure, cannot find graph." << std::endl;
deba@173
  2344
  ///   return -1;
deba@173
  2345
  /// }
alpar@209
  2346
  /// std::cout << "The name of the default node section: "
alpar@179
  2347
  ///           << contents.nodeSection(0) << std::endl;
alpar@209
  2348
  /// std::cout << "The number of the arc maps: "
alpar@179
  2349
  ///           << contents.arcMaps(0).size() << std::endl;
alpar@209
  2350
  /// std::cout << "The name of second arc map: "
alpar@179
  2351
  ///           << contents.arcMaps(0)[1] << std::endl;
deba@173
  2352
  ///\endcode
alpar@209
  2353
  class LgfContents {
deba@173
  2354
  private:
deba@173
  2355
deba@173
  2356
    std::istream* _is;
deba@173
  2357
    bool local_is;
deba@173
  2358
deba@173
  2359
    std::vector<std::string> _node_sections;
deba@173
  2360
    std::vector<std::string> _edge_sections;
deba@173
  2361
    std::vector<std::string> _attribute_sections;
deba@173
  2362
    std::vector<std::string> _extra_sections;
deba@173
  2363
deba@173
  2364
    std::vector<bool> _arc_sections;
deba@173
  2365
deba@173
  2366
    std::vector<std::vector<std::string> > _node_maps;
deba@173
  2367
    std::vector<std::vector<std::string> > _edge_maps;
deba@173
  2368
deba@173
  2369
    std::vector<std::vector<std::string> > _attributes;
deba@173
  2370
deba@173
  2371
deba@173
  2372
    int line_num;
deba@173
  2373
    std::istringstream line;
alpar@209
  2374
deba@173
  2375
  public:
deba@173
  2376
deba@173
  2377
    /// \brief Constructor
deba@173
  2378
    ///
alpar@179
  2379
    /// Construct an \e LGF contents reader, which reads from the given
deba@173
  2380
    /// input stream.
alpar@209
  2381
    LgfContents(std::istream& is)
deba@173
  2382
      : _is(&is), local_is(false) {}
deba@173
  2383
deba@173
  2384
    /// \brief Constructor
deba@173
  2385
    ///
alpar@179
  2386
    /// Construct an \e LGF contents reader, which reads from the given
deba@173
  2387
    /// file.
alpar@209
  2388
    LgfContents(const std::string& fn)
deba@290
  2389
      : _is(new std::ifstream(fn.c_str())), local_is(true) {
deba@290
  2390
      if (!(*_is)) throw IoError(fn, "Cannot open file");
deba@290
  2391
    }
deba@173
  2392
deba@173
  2393
    /// \brief Constructor
deba@173
  2394
    ///
alpar@179
  2395
    /// Construct an \e LGF contents reader, which reads from the given
deba@173
  2396
    /// file.
alpar@179
  2397
    LgfContents(const char* fn)
deba@290
  2398
      : _is(new std::ifstream(fn)), local_is(true) {
deba@290
  2399
      if (!(*_is)) throw IoError(fn, "Cannot open file");
deba@290
  2400
    }
alpar@209
  2401
deba@173
  2402
    /// \brief Destructor
alpar@179
  2403
    ~LgfContents() {
deba@173
  2404
      if (local_is) delete _is;
deba@173
  2405
    }
deba@173
  2406
deba@190
  2407
  private:
alpar@209
  2408
deba@190
  2409
    LgfContents(const LgfContents&);
deba@190
  2410
    LgfContents& operator=(const LgfContents&);
deba@190
  2411
deba@190
  2412
  public:
deba@190
  2413
deba@173
  2414
deba@173
  2415
    /// \name Node sections
deba@173
  2416
    /// @{
deba@173
  2417
deba@173
  2418
    /// \brief Gives back the number of node sections in the file.
deba@173
  2419
    ///
deba@173
  2420
    /// Gives back the number of node sections in the file.
deba@173
  2421
    int nodeSectionNum() const {
deba@173
  2422
      return _node_sections.size();
deba@173
  2423
    }
deba@173
  2424
alpar@209
  2425
    /// \brief Returns the node section name at the given position.
deba@173
  2426
    ///
alpar@209
  2427
    /// Returns the node section name at the given position.
deba@173
  2428
    const std::string& nodeSection(int i) const {
deba@173
  2429
      return _node_sections[i];
deba@173
  2430
    }
deba@173
  2431
deba@173
  2432
    /// \brief Gives back the node maps for the given section.
deba@173
  2433
    ///
deba@173
  2434
    /// Gives back the node maps for the given section.
alpar@182
  2435
    const std::vector<std::string>& nodeMapNames(int i) const {
deba@173
  2436
      return _node_maps[i];
deba@173
  2437
    }
deba@173
  2438
deba@173
  2439
    /// @}
deba@173
  2440
alpar@209
  2441
    /// \name Arc/Edge sections
deba@173
  2442
    /// @{
deba@173
  2443
alpar@181
  2444
    /// \brief Gives back the number of arc/edge sections in the file.
deba@173
  2445
    ///
alpar@181
  2446
    /// Gives back the number of arc/edge sections in the file.
alpar@181
  2447
    /// \note It is synonym of \c edgeSectionNum().
deba@173
  2448
    int arcSectionNum() const {
deba@173
  2449
      return _edge_sections.size();
deba@173
  2450
    }
deba@173
  2451
alpar@209
  2452
    /// \brief Returns the arc/edge section name at the given position.
deba@173
  2453
    ///
alpar@209
  2454
    /// Returns the arc/edge section name at the given position.
alpar@181
  2455
    /// \note It is synonym of \c edgeSection().
deba@173
  2456
    const std::string& arcSection(int i) const {
deba@173
  2457
      return _edge_sections[i];
deba@173
  2458
    }
deba@173
  2459
alpar@181
  2460
    /// \brief Gives back the arc/edge maps for the given section.
deba@173
  2461
    ///
alpar@181
  2462
    /// Gives back the arc/edge maps for the given section.
alpar@182
  2463
    /// \note It is synonym of \c edgeMapNames().
alpar@182
  2464
    const std::vector<std::string>& arcMapNames(int i) const {
deba@173
  2465
      return _edge_maps[i];
deba@173
  2466
    }
deba@173
  2467
deba@173
  2468
    /// @}
deba@173
  2469
alpar@181
  2470
    /// \name Synonyms
deba@173
  2471
    /// @{
deba@173
  2472
alpar@181
  2473
    /// \brief Gives back the number of arc/edge sections in the file.
deba@173
  2474
    ///
alpar@181
  2475
    /// Gives back the number of arc/edge sections in the file.
alpar@181
  2476
    /// \note It is synonym of \c arcSectionNum().
deba@173
  2477
    int edgeSectionNum() const {
deba@173
  2478
      return _edge_sections.size();
deba@173
  2479
    }
deba@173
  2480
alpar@209
  2481
    /// \brief Returns the section name at the given position.
deba@173
  2482
    ///
alpar@209
  2483
    /// Returns the section name at the given position.
alpar@181
  2484
    /// \note It is synonym of \c arcSection().
deba@173
  2485
    const std::string& edgeSection(int i) const {
deba@173
  2486
      return _edge_sections[i];
deba@173
  2487
    }
deba@173
  2488
deba@173
  2489
    /// \brief Gives back the edge maps for the given section.
deba@173
  2490
    ///
deba@173
  2491
    /// Gives back the edge maps for the given section.
alpar@182
  2492
    /// \note It is synonym of \c arcMapNames().
alpar@182
  2493
    const std::vector<std::string>& edgeMapNames(int i) const {
deba@173
  2494
      return _edge_maps[i];
deba@173
  2495
    }
deba@173
  2496
deba@173
  2497
    /// @}
deba@173
  2498
alpar@209
  2499
    /// \name Attribute sections
deba@173
  2500
    /// @{
deba@173
  2501
deba@173
  2502
    /// \brief Gives back the number of attribute sections in the file.
deba@173
  2503
    ///
deba@173
  2504
    /// Gives back the number of attribute sections in the file.
deba@173
  2505
    int attributeSectionNum() const {
deba@173
  2506
      return _attribute_sections.size();
deba@173
  2507
    }
deba@173
  2508
alpar@209
  2509
    /// \brief Returns the attribute section name at the given position.
deba@173
  2510
    ///
alpar@209
  2511
    /// Returns the attribute section name at the given position.
alpar@182
  2512
    const std::string& attributeSectionNames(int i) const {
deba@173
  2513
      return _attribute_sections[i];
deba@173
  2514
    }
deba@173
  2515
deba@173
  2516
    /// \brief Gives back the attributes for the given section.
deba@173
  2517
    ///
deba@173
  2518
    /// Gives back the attributes for the given section.
deba@173
  2519
    const std::vector<std::string>& attributes(int i) const {
deba@173
  2520
      return _attributes[i];
deba@173
  2521
    }
deba@173
  2522
deba@173
  2523
    /// @}
deba@173
  2524
alpar@209
  2525
    /// \name Extra sections
deba@173
  2526
    /// @{
deba@173
  2527
deba@173
  2528
    /// \brief Gives back the number of extra sections in the file.
deba@173
  2529
    ///
deba@173
  2530
    /// Gives back the number of extra sections in the file.
deba@173
  2531
    int extraSectionNum() const {
deba@173
  2532
      return _extra_sections.size();
deba@173
  2533
    }
deba@173
  2534
alpar@209
  2535
    /// \brief Returns the extra section type at the given position.
deba@173
  2536
    ///
alpar@209
  2537
    /// Returns the section type at the given position.
deba@173
  2538
    const std::string& extraSection(int i) const {
deba@173
  2539
      return _extra_sections[i];
deba@173
  2540
    }
deba@173
  2541
deba@173
  2542
    /// @}
deba@173
  2543
deba@173
  2544
  private:
deba@173
  2545
deba@173
  2546
    bool readLine() {
deba@173
  2547
      std::string str;
deba@173
  2548
      while(++line_num, std::getline(*_is, str)) {
alpar@209
  2549
        line.clear(); line.str(str);
alpar@209
  2550
        char c;
alpar@209
  2551
        if (line >> std::ws >> c && c != '#') {
alpar@209
  2552
          line.putback(c);
alpar@209
  2553
          return true;
alpar@209
  2554
        }
deba@173
  2555
      }
deba@173
  2556
      return false;
deba@173
  2557
    }
deba@173
  2558
deba@173
  2559
    bool readSuccess() {
deba@173
  2560
      return static_cast<bool>(*_is);
deba@173
  2561
    }
deba@173
  2562
deba@173
  2563
    void skipSection() {
deba@173
  2564
      char c;
deba@173
  2565
      while (readSuccess() && line >> c && c != '@') {
alpar@209
  2566
        readLine();
deba@173
  2567
      }
deba@173
  2568
      line.putback(c);
deba@173
  2569
    }
deba@173
  2570
deba@173
  2571
    void readMaps(std::vector<std::string>& maps) {
deba@186
  2572
      char c;
deba@186
  2573
      if (!readLine() || !(line >> c) || c == '@') {
alpar@209
  2574
        if (readSuccess() && line) line.putback(c);
alpar@209
  2575
        return;
deba@186
  2576
      }
deba@186
  2577
      line.putback(c);
deba@173
  2578
      std::string map;
deba@173
  2579
      while (_reader_bits::readToken(line, map)) {
alpar@209
  2580
        maps.push_back(map);
deba@173
  2581
      }
deba@173
  2582
    }
deba@173
  2583
deba@173
  2584
    void readAttributes(std::vector<std::string>& attrs) {
deba@173
  2585
      readLine();
deba@173
  2586
      char c;
deba@173
  2587
      while (readSuccess() && line >> c && c != '@') {
alpar@209
  2588
        line.putback(c);
alpar@209
  2589
        std::string attr;
alpar@209
  2590
        _reader_bits::readToken(line, attr);
alpar@209
  2591
        attrs.push_back(attr);
alpar@209
  2592
        readLine();
deba@173
  2593
      }
deba@173
  2594
      line.putback(c);
deba@173
  2595
    }
deba@173
  2596
deba@173
  2597
  public:
deba@173
  2598
alpar@209
  2599
    /// \name Execution of the contents reader
deba@173
  2600
    /// @{
deba@173
  2601
kpeter@192
  2602
    /// \brief Starts the reading
deba@173
  2603
    ///
kpeter@192
  2604
    /// This function starts the reading.
deba@173
  2605
    void run() {
deba@173
  2606
deba@173
  2607
      readLine();
deba@173
  2608
      skipSection();
deba@173
  2609
deba@173
  2610
      while (readSuccess()) {
deba@173
  2611
alpar@209
  2612
        char c;
alpar@209
  2613
        line >> c;
alpar@209
  2614
alpar@209
  2615
        std::string section, caption;
alpar@209
  2616
        _reader_bits::readToken(line, section);
alpar@209
  2617
        _reader_bits::readToken(line, caption);
alpar@209
  2618
alpar@209
  2619
        if (section == "nodes") {
alpar@209
  2620
          _node_sections.push_back(caption);
alpar@209
  2621
          _node_maps.push_back(std::vector<std::string>());
alpar@209
  2622
          readMaps(_node_maps.back());
alpar@209
  2623
          readLine(); skipSection();
alpar@209
  2624
        } else if (section == "arcs" || section == "edges") {
alpar@209
  2625
          _edge_sections.push_back(caption);
alpar@209
  2626
          _arc_sections.push_back(section == "arcs");
alpar@209
  2627
          _edge_maps.push_back(std::vector<std::string>());
alpar@209
  2628
          readMaps(_edge_maps.back());
alpar@209
  2629
          readLine(); skipSection();
alpar@209
  2630
        } else if (section == "attributes") {
alpar@209
  2631
          _attribute_sections.push_back(caption);
alpar@209
  2632
          _attributes.push_back(std::vector<std::string>());
alpar@209
  2633
          readAttributes(_attributes.back());
alpar@209
  2634
        } else {
alpar@209
  2635
          _extra_sections.push_back(section);
alpar@209
  2636
          readLine(); skipSection();
alpar@209
  2637
        }
deba@173
  2638
      }
deba@173
  2639
    }
deba@173
  2640
deba@173
  2641
    /// @}
alpar@209
  2642
deba@173
  2643
  };
deba@127
  2644
}
deba@127
  2645
deba@127
  2646
#endif